man POE::Component::IRC::Qnet () - a fully event-driven IRC client module for Quakenet.
NAME
POE::Component::IRC::Qnet - a fully event-driven IRC client module for Quakenet.
SYNOPSIS
use POE::Component::IRC::Qnet;
# Do this when you create your sessions. 'my client' is just a # kernel alias to christen the new IRC connection with. my ($object) = POE::Component::IRC::Qnet->new('my client') or die "Oh noooo! $!";
# Do stuff like this from within your sessions. This line tells the # connection named "my client" to send your session the following # events when they happen. $kernel->post('my client', 'register', qw(connected msg public cdcc cping)); # You can guess what this line does. $kernel->post('my client', 'connect', { Nick => 'Boolahman', Server => 'irc-w.primenet.com', Port => 6669, Username => 'quetzal', Ircname => 'Ask me about my colon!', } );
DESCRIPTION
POE::Component::IRC::Qnet is an extension to POE::Component::IRC specifically for use on Quakenet <http://www.quakenet.org/>. See the documentation for POE::Component::IRC for general usage. This document covers the extensions.
The module provides a number of additional commands for communicating with the Quakenet service bots, Q and L.
METHODS
- service_bots
- The component will query Q and L using their default names on Quakenet. If you wish to override these settings, use this method to configure them. $self->service_bots( QBOT => 'W@blah.network.net', LBOT => 'Z@blah.network.net' ); In most cases you shouldn't need to mess with these >;o)
INPUT
The Quakenet service bots accept input as PRIVMSG. This module provides a wrapper around the POE::Component::IRC privmsg command.
- qbot_*
- Send commands to the Q bot. Pass additional command parameters as arguments to the event. $kernel->post ( 'my client' => qbot_auth => CW$q_user => CW$q_pass );
- lbot_*
- Send commands to the L bot. Pass additional command parameters as arguments to the event. $kernel->post ( 'my client' => lbot_chanlev => CW$channel );
OUTPUT
All output from the Quakenet service bots is sent as NOTICEs. Use 'irc_notice' to trap these.
- irc_whois
- Has all the same hash keys in ARG1 as POE::Component::IRC, with the addition of 'account', which contains the name of their Q auth account, if they have authed, or undef if they haven't.
BUGS
A few have turned up in the past and they are sure to again. Please use <http://rt.cpan.org/> to report any. Alternatively, email the current maintainer.
AUTHOR
Chris 'BinGOs' Williams <chris@bingosnet.co.uk>
Based on the original POE::Component::IRC by:
Dennis Taylor, <dennis@funkplanet.com>
SEE ALSO
POE::Component::IRC <http://www.quakenet.org/>