Net/IRC3/Client.pm

package Net::IRC3::Client;
use base Net::IRC3;
$Net::IRC3::ConnectionClass = 'Net::IRC3::Client::Connection';

=head1 NAME

Net::IRC3::Client - An IRC client abstraction that makes things easier for you

=head1 SYNOPSIS

   my $irccl = new Net::IRC3::Client;

   my $con = $irccl->connect ($host, $port);
   #...
   $con->send_msg (undef, "PRIVMSG", "Hello there!", "yournick");
   #...

=head1 DESCRIPTION

This is the highlevel IRC client module, that will do lot's of stuff
you don't want to do yourself. Actually the interesting stuff is done in
L<Net::IRC3::Client::Connection>. So look there for a explanation of what
interesting stuff you can actually do.

(To be honest: This is just a wrapper module that sets C<$Net::IRC3::ConnectionClass> to C<'Net::IRC3::Client::Connection'>).

=head2 METHODS

The following methods work I<exactly> like the same functions
in L<Net::IRC3>, only that they will return L<Net::IRC3::Client::Connection> objects:

=over 4

=item B<connect ($host, $port)>

=item B<connections ()>

=item B<connection ()>

=back

=head1 EXAMPLES

See samples/netirc3cl and other samples in samples/ for some examples on how to use Net::IRC3::Client.

=head1 AUTHOR

Robin Redeker, C<< <elmex@ta-sa.org> >>

=head1 SEE ALSO

L<Net::IRC3>

L<Net::IRC3::Connection>

L<Net::IRC3::Client::Connection>

RFC 2812 - Internet Relay Chat: Client Protocol

=head1 COPYRIGHT & LICENSE

Copyright 2006 Robin Redker, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1;
Revision:	1.4
Committed:	Mon Jul 17 15:09:20 2006 UTC (18 years, 4 months ago) by elmex
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.3:	+0 -0 lines
State:	*FILE REMOVED*
Log Message:	simplyfied the whole module a bit.
#	User	Rev	Content
1	elmex	1.1	package Net::IRC3::Client;
2	elmex	1.2	use base Net::IRC3;
3			$Net::IRC3::ConnectionClass = 'Net::IRC3::Client::Connection';
4	elmex	1.1
5	elmex	1.2	=head1 NAME
6	elmex	1.1
7	elmex	1.3	Net::IRC3::Client - An IRC client abstraction that makes things easier for you
8	elmex	1.1
9	elmex	1.2	=head1 SYNOPSIS
10	elmex	1.1
11	elmex	1.2	my $irccl = new Net::IRC3::Client;
12	elmex	1.1
13	elmex	1.2	my $con = $irccl->connect ($host, $port);
14			#...
15			$con->send_msg (undef, "PRIVMSG", "Hello there!", "yournick");
16			#...
17	elmex	1.1
18	elmex	1.2	=head1 DESCRIPTION
19	elmex	1.1
20	elmex	1.2	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	elmex	1.1
25	elmex	1.2	(To be honest: This is just a wrapper module that sets C<$Net::IRC3::ConnectionClass> to C<'Net::IRC3::Client::Connection'>).
26	elmex	1.1
27	elmex	1.2	=head2 METHODS
28	elmex	1.1
29	elmex	1.2	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	elmex	1.1
32	elmex	1.2	=over 4
33	elmex	1.1
34	elmex	1.2	=item B<connect ($host, $port)>
35	elmex	1.1
36	elmex	1.2	=item B<connections ()>
37	elmex	1.1
38	elmex	1.2	=item B<connection ()>
39	elmex	1.1
40	elmex	1.2	=back
41	elmex	1.1
42	elmex	1.2	=head1 EXAMPLES
43	elmex	1.1
44	elmex	1.2	See samples/netirc3cl and other samples in samples/ for some examples on how to use Net::IRC3::Client.
45	elmex	1.1
46	elmex	1.2	=head1 AUTHOR
47	elmex	1.1
48	elmex	1.2	Robin Redeker, C<< <elmex@ta-sa.org> >>
49	elmex	1.1
50	elmex	1.2	=head1 SEE ALSO
51	elmex	1.1
52	elmex	1.2	L<Net::IRC3>
53	elmex	1.1
54	elmex	1.2	L<Net::IRC3::Connection>
55	elmex	1.1
56	elmex	1.2	L<Net::IRC3::Client::Connection>
57	elmex	1.1
58	elmex	1.2	RFC 2812 - Internet Relay Chat: Client Protocol
59	elmex	1.1
60	elmex	1.2	=head1 COPYRIGHT & LICENSE
61	elmex	1.1
62	elmex	1.2	Copyright 2006 Robin Redker, all rights reserved.
63	elmex	1.1
64	elmex	1.2	This program is free software; you can redistribute it and/or modify it
65			under the same terms as Perl itself.
66	elmex	1.1
67	elmex	1.2	=cut
68	elmex	1.1
69			1;