Karl Y. Pradène > Net-IRC2-0.27 > Net::IRC2

Download:
Net-IRC2-0.27.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.27   Source  

NAME ^

Net::IRC2 - Client interface to the Internet Relay Chat protocol.

VERSION ^

 !!! UNDER PROGRAMMING !!!
 You can use and feedback is welcome ( in english or french )

SYNOPSIS ^

 use Net::IRC2                                                        ;
 my $bot  = new Net::IRC2                                             ;
 my $conn = $bot->newconn( uri => 'irc://Nick!User@localhost:6667/' ) ; 
 $conn->mode( $conn->nick, '+B' )                                     ;
 $conn->mode(  '#Ailleurs +m'   )                                     ;
 $bot->add_default_handler( \&process_event )                         ;
 $bot->start                                                          ;
 ...

DESCRIPTION ^

This module will provide you an access to the IRC protocol suitable to write your own IRC-Bots, or your IRC Client. The API will provide you the sames functions than Net::IRC, so change should be trivial. This module use Parse::RecDescent; by Dr. Conway Damian.

FUNCTIONS ^

new()

The constructor, takes no argument. Return a Net::IRC2 object. It's your IRC-Bot.

newconn()

Make a new connection. Like Net::IRC + can process a home-made tasty pseudo-URI : irc://Nick!User@localhost:6667/ . Yummy.

start()

Start the bot

add_handler()

set handler for all messages matching a command in commands list. $bot->add_handler( [ '001'..'005' ], \&function ) ;

add_default_handler()

The simple way to handle all events with only one function. set handler for ALL messages $bot->add_default_handler( \&function ) ;

connections()

return un ARRAY of Net::IRC2::Connection objects

irc_grammar()

! Internal !

callback()

! DEPRECATED !

BUGS ^

Please report any bugs or feature requests to bug-net-irc2@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-IRC2. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SEE ALSO ^

Others Perl modules working with IRC connections: Net::IRC, POE::Component::IRC

IRC Request For Comment 1459 http://www.ietf.org/rfc/rfc1459.txt

AUTHOR ^

Karl Y. Pradene, <knotty@cpan.org>, irc://knotty@freenode.org/

COPYRIGHT & LICENSE ^

Copyright 2005, Karl Y. Pradene <knotty@cpan.org> All rights reserved.

This program is released under the following license: GNU General Public License, version 2

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the

 Free Software Foundation,
 Inc., 51 Franklin St, Fifth Floor,
 Boston, MA  02110-1301 USA

See http://www.fsf.org/licensing/licenses/gpl.html

syntax highlighting: