1Net::Jabber(3)        User Contributed Perl Documentation       Net::Jabber(3)
2
3
4

NAME

6       Net::Jabber - Jabber Perl Library
7

SYNOPSIS

9         Net::Jabber provides a Perl user with access to the Jabber Instant
10         Messaging protocol.
11
12         For more information about Jabber visit:
13
14           http://www.jabber.org
15

DESCRIPTION

17         Net::Jabber is a convenient tool to use for any perl script that would
18         like to utilize the Jabber Instant Messaging protocol.  While not a
19         client in and of itself, it provides all of the necessary back-end
20         functions to make a CGI client or command-line perl client feasible and
21         easy to use.  Net::Jabber is a wrapper around the rest of the official
22         Net::Jabber::xxxxxx packages.
23
24         There is are example scripts in the example directory that provide you
25         with examples of very simple Jabber programs.
26
27         NOTE: The parser that XML::Stream::Parser provides, as are most Perl
28         parsers, is synchronous.  If you are in the middle of parsing a packet
29         and call a user defined callback, the Parser is blocked until your
30         callback finishes.  This means you cannot be operating on a packet,
31         send out another packet and wait for a response to that packet.  It
32         will never get to you.  Threading might solve this, but as of the
33         writing of this, threading in Perl is not quite up to par yet.  This
34         issue will be revisted in the future.
35

EXAMPLES

37           For a client:
38             use Net::Jabber;
39             my $client = new Net::Jabber::Client();
40
41           For a component:
42             use Net::Jabber;
43             my $component = new Net::Jabber::Component();
44

METHODS

46         The Net::Jabber module does not define any methods that you will call
47         directly in your code.  Instead you will instantiate objects that call
48         functions from this module to do work.  The three main objects that
49         you will work with are the Message, Presence, and IQ modules.  Each one
50         corresponds to the Jabber equivilant and allows you get and set all
51         parts of those packets.
52

PACKAGES

54         For more information on each of these packages, please see the man page
55         for each one.
56
57       Net::Jabber::Client
58
59         This package contains the code needed to communicate with a Jabber
60         server: login, wait for messages, send messages, and logout.  It uses
61         XML::Stream to read the stream from the server and based on what kind
62         of tag it encounters it calls a function to handle the tag.
63
64       Net::Jabber::Component
65
66         This package contains the code needed to write a server component.  A
67         component is a program tha handles the communication between a jabber
68         server and some outside program or communications pacakge (IRC, talk,
69         email, etc...)  With this module you can write a full component in just
70         a few lines of Perl.  It uses XML::Stream to communicate with its host
71         server and based on what kind of tag it encounters it calls a function
72         to handle the tag.
73
74       Net::Jabber::Protocol
75
76         A collection of high-level functions that Client and Component use to
77         make their lives easier through inheritance.
78
79       Net::Jabber::JID
80
81         The Jabber IDs consist of three parts: user id, server, and resource.
82         This module gives you access to those components without having to
83         parse the string yourself.
84
85       Net::Jabber::Message
86
87         Everything needed to create and read a <message/> received from the
88         server.
89
90       Net::Jabber::Presence
91
92         Everything needed to create and read a <presence/> received from the
93         server.
94
95       Net::Jabber::IQ
96
97         IQ is a wrapper around a number of modules that provide support for the
98         various Info/Query namespaces that Jabber recognizes.
99
100       Net::Jabber::Stanza
101
102         This module represents a namespaced stanza that is used to extend a
103         <message/>, <presence/>, and <iq/>.  Ultimately each namespace is
104         documented in a JEP of some kind.  http://jabber.org/jeps/
105
106         The man page for Net::Jabber::Stanza contains a listing of all
107         supported namespaces, and the methods that are supported by the objects
108         that represent those namespaces.
109
110       Net::Jabber::Namespaces
111
112         Jabber allows for any stanza to be extended by any bit of XML.  This
113         module contains all of the internals for defining the Jabber based
114         extensions defined by the JEPs.  The documentation for this module
115         explains more about how to add your own custom namespace and have it be
116         supported.
117

AUTHOR

119       Ryan Eatmon
120

122       This module is free software, you can redistribute it and/or modify it
123       under the same terms as Perl itself.
124
125
126
127perl v5.8.8                       2004-08-16                    Net::Jabber(3)
Impressum