| 1 |
package Net::IRC3::Client; |
| 2 |
use base Net::IRC3; |
| 3 |
$Net::IRC3::ConnectionClass = 'Net::IRC3::Client::Connection'; |
| 4 |
|
| 5 |
=head1 NAME |
| 6 |
|
| 7 |
Net::IRC3::Client - An IRC client abstraction that makes things easier for you |
| 8 |
|
| 9 |
=head1 SYNOPSIS |
| 10 |
|
| 11 |
my $irccl = new Net::IRC3::Client; |
| 12 |
|
| 13 |
my $con = $irccl->connect ($host, $port); |
| 14 |
#... |
| 15 |
$con->send_msg (undef, "PRIVMSG", "Hello there!", "yournick"); |
| 16 |
#... |
| 17 |
|
| 18 |
=head1 DESCRIPTION |
| 19 |
|
| 20 |
This is the highlevel IRC client module, that will do lot's of stuff |
| 21 |
you don't want to do yourself. Actually the interesting stuff is done in |
| 22 |
L<Net::IRC3::Client::Connection>. So look there for a explanation of what |
| 23 |
interesting stuff you can actually do. |
| 24 |
|
| 25 |
(To be honest: This is just a wrapper module that sets C<$Net::IRC3::ConnectionClass> to C<'Net::IRC3::Client::Connection'>). |
| 26 |
|
| 27 |
=head2 METHODS |
| 28 |
|
| 29 |
The following methods work I<exactly> like the same functions |
| 30 |
in L<Net::IRC3>, only that they will return L<Net::IRC3::Client::Connection> objects: |
| 31 |
|
| 32 |
=over 4 |
| 33 |
|
| 34 |
=item B<connect ($host, $port)> |
| 35 |
|
| 36 |
=item B<connections ()> |
| 37 |
|
| 38 |
=item B<connection ()> |
| 39 |
|
| 40 |
=back |
| 41 |
|
| 42 |
=head1 EXAMPLES |
| 43 |
|
| 44 |
See samples/netirc3cl and other samples in samples/ for some examples on how to use Net::IRC3::Client. |
| 45 |
|
| 46 |
=head1 AUTHOR |
| 47 |
|
| 48 |
Robin Redeker, C<< <elmex@ta-sa.org> >> |
| 49 |
|
| 50 |
=head1 SEE ALSO |
| 51 |
|
| 52 |
L<Net::IRC3> |
| 53 |
|
| 54 |
L<Net::IRC3::Connection> |
| 55 |
|
| 56 |
L<Net::IRC3::Client::Connection> |
| 57 |
|
| 58 |
RFC 2812 - Internet Relay Chat: Client Protocol |
| 59 |
|
| 60 |
=head1 COPYRIGHT & LICENSE |
| 61 |
|
| 62 |
Copyright 2006 Robin Redker, all rights reserved. |
| 63 |
|
| 64 |
This program is free software; you can redistribute it and/or modify it |
| 65 |
under the same terms as Perl itself. |
| 66 |
|
| 67 |
=cut |
| 68 |
|
| 69 |
1; |
