ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Net-IRC3/lib/Net/IRC3.pm
Revision: 1.7
Committed: Mon Jul 17 15:09:20 2006 UTC (18 years, 2 months ago) by elmex
Branch: MAIN
Changes since 1.6: +3 -105 lines
Log Message:
simplyfied the whole module a bit.

File Contents

# User Rev Content
1 elmex 1.1 package Net::IRC3;
2     use strict;
3     use AnyEvent;
4     use IO::Socket::INET;
5 elmex 1.2
6 elmex 1.3 our $ConnectionClass = 'Net::IRC3::Connection';
7 elmex 1.2
8 elmex 1.1 =head1 NAME
9    
10     Net::IRC3 - An IRC Protocol module which is event system independend
11    
12     =head1 VERSION
13    
14 elmex 1.4 Version 0.21
15 elmex 1.1
16     =cut
17    
18 elmex 1.4 our $VERSION = '0.21';
19 elmex 1.1
20     =head1 SYNOPSIS
21    
22 elmex 1.7 use Net::IRC3::Connection;
23 elmex 1.1
24 elmex 1.7 my $con = new Net::IRC3::Connection;
25 elmex 1.1
26 elmex 1.7 $con->connect ("test.not.at.irc.net", 6667);
27 elmex 1.1
28    
29     =head1 DESCRIPTION
30    
31     L<Net::IRC3> itself is a simple building block for an IRC client.
32     It manages connections and parses and constructs IRC messages.
33    
34     L<Net::IRC3> is I<very> simple, if you don't want to care about
35     all the other things that a client still has to do (like replying to
36     PINGs and remembering who is on a channel), I recommend to read
37     the L<Net::IRC3::Client> page instead.
38    
39 elmex 1.4 Note that this module uses AnyEvent as it's IO event subsystem.
40     You can integrate Net::IRC3 into any application with a event system
41     that AnyEvent has support for (eg. L<Gtk2> or L<Event>).
42    
43 elmex 1.2 =head1 EXAMPLES
44 elmex 1.1
45 elmex 1.2 See the samples/ directory for some examples on how to use Net::IRC3.
46 elmex 1.1
47     =head1 AUTHOR
48    
49     Robin Redeker, C<< <elmex@ta-sa.org> >>
50    
51     =head1 SEE ALSO
52    
53 elmex 1.2 L<Net::IRC3::Connection>
54    
55     L<Net::IRC3::Client>
56    
57 elmex 1.4 L<AnyEvent>
58    
59 elmex 1.1 RFC 2812 - Internet Relay Chat: Client Protocol
60    
61     =head1 BUGS
62    
63     Please report any bugs or feature requests to
64     C<bug-net-irc3 at rt.cpan.org>, or through the web interface at
65     L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-IRC3>.
66     I will be notified, and then you'll automatically be notified of progress on
67     your bug as I make changes.
68    
69     =head1 SUPPORT
70    
71     You can find documentation for this module with the perldoc command.
72    
73     perldoc Net::IRC3
74    
75     You can also look for information at:
76    
77     =over 4
78    
79     =item * AnnoCPAN: Annotated CPAN documentation
80    
81     L<http://annocpan.org/dist/Net-IRC3>
82    
83     =item * CPAN Ratings
84    
85     L<http://cpanratings.perl.org/d/Net-IRC3>
86    
87     =item * RT: CPAN's request tracker
88    
89     L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-IRC3>
90    
91     =item * Search CPAN
92    
93     L<http://search.cpan.org/dist/Net-IRC3>
94    
95     =back
96    
97     =head1 ACKNOWLEDGEMENTS
98    
99     Thanks to Marc Lehmann for the new AnyEvent module!
100    
101     =head1 COPYRIGHT & LICENSE
102    
103     Copyright 2006 Robin Redker, all rights reserved.
104    
105     This program is free software; you can redistribute it and/or modify it
106     under the same terms as Perl itself.
107    
108     =cut
109    
110     1;