lib/Net/XMPP2.pm

package Net::XMPP2;
use warnings;
use strict;

=head1 NAME

Net::XMPP2 - An implementation of the XMPP Protocol

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.01';

=head1 SYNOPSIS

   use Net::XMPP2::Connection;

or:

   use Net::XMPP2::IM::Connection;

or:

   use Net::XMPP2::Client;

=head1 DESCRIPTION

This is the head module of the L<Net::XMPP2> XMPP client protocol (as described in
RFC 3920 and RFC 3921) framework.

L<Net::XMPP2::Connection> is a RFC 3920 conformant "XML" stream implementation
for clients, which handles tcp connect up to the resource binding. And provides
low-level access to the XML nodes on the XML stream along with some high
level methods to send the predefined XML stanzas.

L<Net::XMPP2::IM::Connection> is a more highlevel module, which is derived
from L<Net::XMPP2::Connection>. It handles all the instant messaging client
functionality described in RFC 3921.

L<Net::XMPP2::Client> is a multi account client class. It manages connections
to multiple XMPP accounts and tries to offer a nice highlevel interface
to XMPP communication.

For a list of L<Supportet extensions> see below.

There are also other modules in this distribution, for example:
L<Net::XMPP2::Util>, L<Net::XMPP2::Writer>, L<Net::XMPP2::Parser> and those I
forgot :-) Those modules might be helpful and/or required if you want to use
this framework for XMPP.

See also L<Net::XMPP2::Writer> for a discussion about the brokeness of XML in the XMPP
specification.

=head1 RELEASE NOTES

Here are some notes to the releases (release of this version is at top):

=head2 Version

=over 4

=item 0.01

This release has beta status. The code is already used daily in my client
and I keep looking out for bugs. If you find undocumented, missing or faulty
code/methods please drop me a mail! See also L<BUGS> below.

Potential edges when using this module: under-documented methods, missing
functionality and generally bugs bugs and bugs. Even thought this module is in
daily usage there are still lots of cases I might have missed.

For the next release I'm planning to provide more examples in the documentation
or samples/ directory, along with bugfixes and enhancements along with some
todo items killed from the TODO file.

=back

=head2 TODO

There are still lots of items on the TODO list (see also the TODO file
in the distribution of Net::XMPP2). For further and more detailed todo items
look there.

=head1 Why (yet) another XMPP module?

The main outstanding feature of this module in comparsion to the other XMPP
(aka Jabber) modules out there is the support for L<AnyEvent>. L<AnyEvent>
permits you to use this module together with other I/O event based programs and
libraries (ie. L<Gtk2> or L<Event>).

The other modules could often only be integrated in those applications or librarys
by using threads. I decided to write this module because I think CPAN lacks
an event based XMPP module. Threads are unfortunately not an alternative in Perl
at the moment due the limited threading functionality they provide and the global
speed hit. I also think that a simple event based I/O framework might be a bit easier
to handle than threads.

Another thing was that I didn't like the APIs of the other modules. In L<Net::XMPP2>
I try to provide low level modules for speaking XMPP as defined in RFC 3920 and RFC 3921
(see also L<Net::XMPP2::Connection> and L<Net::XMPP2::IM::Connection>). But I also
try to provide a high level API for easier usage for instant messaging tasks
and clients (eg. L<Net::XMPP2::IM::Client>).

=head1 A note about TLS

This module also supports TLS, as the specification of XMPP requires an
implementation to support TLS.

There are maybe still some bugs in the handling of TLS in L<Net::XMPP2::Connection>.
So keep an eye on TLS with this module. If you encounter any problems it would be
very helpful if you could debug them or at least send me a detailed report on how
to reproduce the problem.

(As I use this module myself I don't expect TLS to be completly broken, but it
might break under different circumstances than I have here.  Those
circumstances might be a different load of data pumped through the TLS
connection.)

I mainly expect problems where aviable data isn't properly read from the socket
or written to it. You might want to take a look at the C<debug_send> and C<debug_recv>
events in L<Net::XMPP2::Connection>.

=head1 Supportet extensions

See L<Net::XMPP2::Ext> for a list.

=head1 AUTHOR

Robin Redeker, C<< <elmex at ta-sa.org> >>, JID: C<< <elmex at jabber.org> >>

=head1 BUGS

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

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Net::XMPP2

You can also look for information at:

=over 4

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/Net-XMPP2>

=item * CPAN Ratings

L<http://cpanratings.perl.org/d/Net-XMPP2>

=item * RT: CPAN's request tracker

L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-XMPP2>

=item * Search CPAN

L<http://search.cpan.org/dist/Net-XMPP2>

=back

=head1 ACKNOWLEDGEMENTS

=head1 COPYRIGHT & LICENSE

Copyright 2007 Robin Redeker, 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; # End of Net::XMPP2
Revision:	1.11
Committed:	Wed Jul 4 16:05:22 2007 UTC (19 years, 3 months ago) by elmex
Branch:	MAIN
Changes since 1.10:	+43 -4 lines
Log Message:	major documentation refresh. preparing for release
#	User	Rev	Content
1	elmex	1.1	package Net::XMPP2;
2			use warnings;
3			use strict;
4
5			=head1 NAME
6
7			Net::XMPP2 - An implementation of the XMPP Protocol
8
9			=head1 VERSION
10
11			Version 0.01
12
13			=cut
14
15			our $VERSION = '0.01';
16
17			=head1 SYNOPSIS
18
19	elmex	1.2	use Net::XMPP2::Connection;
20	elmex	1.1
21	elmex	1.2	or:
22	elmex	1.1
23	elmex	1.2	use Net::XMPP2::IM::Connection;
24	elmex	1.1
25	elmex	1.11	or:
26
27			use Net::XMPP2::Client;
28
29	elmex	1.2	=head1 DESCRIPTION
30
31			This is the head module of the L<Net::XMPP2> XMPP client protocol (as described in
32	elmex	1.4	RFC 3920 and RFC 3921) framework.
33	elmex	1.2
34	elmex	1.4	L<Net::XMPP2::Connection> is a RFC 3920 conformant "XML" stream implementation
35	elmex	1.5	for clients, which handles tcp connect up to the resource binding. And provides
36			low-level access to the XML nodes on the XML stream along with some high
37			level methods to send the predefined XML stanzas.
38	elmex	1.2
39	elmex	1.4	L<Net::XMPP2::IM::Connection> is a more highlevel module, which is derived
40			from L<Net::XMPP2::Connection>. It handles all the instant messaging client
41	elmex	1.5	functionality described in RFC 3921.
42
43	elmex	1.11	L<Net::XMPP2::Client> is a multi account client class. It manages connections
44			to multiple XMPP accounts and tries to offer a nice highlevel interface
45			to XMPP communication.
46
47	elmex	1.9	For a list of L<Supportet extensions> see below.
48	elmex	1.2
49			There are also other modules in this distribution, for example:
50	elmex	1.11	L<Net::XMPP2::Util>, L<Net::XMPP2::Writer>, L<Net::XMPP2::Parser> and those I
51	elmex	1.2	forgot :-) Those modules might be helpful and/or required if you want to use
52			this framework for XMPP.
53
54			See also L<Net::XMPP2::Writer> for a discussion about the brokeness of XML in the XMPP
55			specification.
56
57	elmex	1.11	=head1 RELEASE NOTES
58
59			Here are some notes to the releases (release of this version is at top):
60
61			=head2 Version
62
63			=over 4
64
65			=item 0.01
66
67			This release has beta status. The code is already used daily in my client
68			and I keep looking out for bugs. If you find undocumented, missing or faulty
69			code/methods please drop me a mail! See also L<BUGS> below.
70
71			Potential edges when using this module: under-documented methods, missing
72			functionality and generally bugs bugs and bugs. Even thought this module is in
73			daily usage there are still lots of cases I might have missed.
74
75			For the next release I'm planning to provide more examples in the documentation
76			or samples/ directory, along with bugfixes and enhancements along with some
77			todo items killed from the TODO file.
78
79			=back
80
81			=head2 TODO
82
83			There are still lots of items on the TODO list (see also the TODO file
84			in the distribution of Net::XMPP2). For further and more detailed todo items
85			look there.
86
87	elmex	1.2	=head1 Why (yet) another XMPP module?
88
89			The main outstanding feature of this module in comparsion to the other XMPP
90			(aka Jabber) modules out there is the support for L<AnyEvent>. L<AnyEvent>
91			permits you to use this module together with other I/O event based programs and
92			libraries (ie. L<Gtk2> or L<Event>).
93
94			The other modules could often only be integrated in those applications or librarys
95	elmex	1.11	by using threads. I decided to write this module because I think CPAN lacks
96	elmex	1.4	an event based XMPP module. Threads are unfortunately not an alternative in Perl
97			at the moment due the limited threading functionality they provide and the global
98			speed hit. I also think that a simple event based I/O framework might be a bit easier
99			to handle than threads.
100	elmex	1.2
101			Another thing was that I didn't like the APIs of the other modules. In L<Net::XMPP2>
102	elmex	1.9	I try to provide low level modules for speaking XMPP as defined in RFC 3920 and RFC 3921
103			(see also L<Net::XMPP2::Connection> and L<Net::XMPP2::IM::Connection>). But I also
104	elmex	1.11	try to provide a high level API for easier usage for instant messaging tasks
105			and clients (eg. L<Net::XMPP2::IM::Client>).
106	elmex	1.2
107			=head1 A note about TLS
108
109			This module also supports TLS, as the specification of XMPP requires an
110	elmex	1.7	implementation to support TLS.
111	elmex	1.2
112			There are maybe still some bugs in the handling of TLS in L<Net::XMPP2::Connection>.
113	elmex	1.7	So keep an eye on TLS with this module. If you encounter any problems it would be
114			very helpful if you could debug them or at least send me a detailed report on how
115			to reproduce the problem.
116
117			(As I use this module myself I don't expect TLS to be completly broken, but it
118			might break under different circumstances than I have here. Those
119			circumstances might be a different load of data pumped through the TLS
120			connection.)
121	elmex	1.1
122	elmex	1.2	I mainly expect problems where aviable data isn't properly read from the socket
123			or written to it. You might want to take a look at the C<debug_send> and C<debug_recv>
124			events in L<Net::XMPP2::Connection>.
125	elmex	1.1
126	elmex	1.4	=head1 Supportet extensions
127	elmex	1.3
128	elmex	1.10	See L<Net::XMPP2::Ext> for a list.
129	elmex	1.3
130	elmex	1.1	=head1 AUTHOR
131
132	elmex	1.11	Robin Redeker, C<< <elmex at ta-sa.org> >>, JID: C<< <elmex at jabber.org> >>
133	elmex	1.1
134			=head1 BUGS
135
136			Please report any bugs or feature requests to
137			C<bug-net-xmpp2 at rt.cpan.org>, or through the web interface at
138			L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-XMPP2>.
139			I will be notified, and then you'll automatically be notified of progress on
140			your bug as I make changes.
141
142			=head1 SUPPORT
143
144			You can find documentation for this module with the perldoc command.
145
146			perldoc Net::XMPP2
147
148			You can also look for information at:
149
150			=over 4
151
152			=item * AnnoCPAN: Annotated CPAN documentation
153
154			L<http://annocpan.org/dist/Net-XMPP2>
155
156			=item * CPAN Ratings
157
158			L<http://cpanratings.perl.org/d/Net-XMPP2>
159
160			=item * RT: CPAN's request tracker
161
162			L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-XMPP2>
163
164			=item * Search CPAN
165
166			L<http://search.cpan.org/dist/Net-XMPP2>
167
168			=back
169
170			=head1 ACKNOWLEDGEMENTS
171
172			=head1 COPYRIGHT & LICENSE
173
174			Copyright 2007 Robin Redeker, all rights reserved.
175
176			This program is free software; you can redistribute it and/or modify it
177			under the same terms as Perl itself.
178
179			=cut
180
181			1; # End of Net::XMPP2