NAME
Net::Jabber::Client - Jabber Client Library
SYNOPSIS
Net::Jabber::Client is a module that provides a developer easy access
to the Jabber Instant Messaging protocol.DESCRIPTION
Client.pm seeks to provide enough high level APIs and automation of
the low level APIs that writing a Jabber Client in Perl is trivial.
For those that wish to work with the low level you can do that too,
but those functions are covered in the documentation for each module.
Net::Jabber::Client provides functions to connect to a Jabber server,
login, send and receive messages, set personal information, create
a new user account, manage the roster, and disconnect. You can use
all or none of the functions, there is no requirement.
For more information on how the details for how Net::Jabber is written
please see the help for Net::Jabber itself.Basic Functions
use Net::Jabber;
$Con = new Net::Jabber::Client();
$Con->Connect(name=>"jabber.org");
$Con->SetCallBacks(message=>\&messageCallBack,
iq=>\&handleTheIQTag);
$Con->Process();
$Con->Process(5);
$Con->Send($object);
$Con->Send("<tag>XML</tag>");
$Con->Disconnect();ID Functions
$id = $Con->SendWithID($sendObj);
$id = $Con->SendWithID("<tag>XML</tag>");
$receiveObj = $Con->SendAndReceiveWithID($sendObj);
$receiveObj = $Con->SendAndReceiveWithID("<tag>XML</tag>");
$yesno = $Con->ReceivedID($id);
$receiveObj = $Con->GetID($id);
$receiveObj = $Con->WaitForID($id);
$Con->IgnoreIDs();
$Con->WatchIDs();Message Functions
$Con->MessageSend(to=>"bob@jabber.org",
subject=>"Lunch",
body=>"Let's go grab some...\n";
thread=>"ABC123",
priority=>10);Presence Functions
$Con->PresenceSend();IQ::Auth Functions
@result = $Con->AuthSend();
@result = $Con->AuthSend(username=>"bob",
password=>"bobrulez",
resource=>"Bob");IQ::Info Functions
n/aIQ::Register Functions
@result = $Con->RegisterSend(usersname=>"newuser",
resource=>"New User",
password=>"imanewbie");IQ::Resource Functions
n/aIQ::Roster Functions
$Con->RosterGet();
$Con->RosterAdd(jid=>"bob@jabber.org");
$Con->RosterRemove(jid=>"bob@jabber.org");X Functions
$Con->SetXDelegates("com:bar:foo"=>"Foo::Bar");METHODS
Basic Functions
Connect(name=>string, - opens a connection to the server listed in
port=>integer) the name value, on the port listed. The
defaults for the two are localhost and 5222.
SetCallBacks(message=>function, - sets the callback functions for
presence=>function, the top level tags listed. The
iq=>function) available tags to look for are
<message/>, <presence/>, and
<iq/>. If a packet is received
with an ID then it is not sent
to these functions, instead it
is inserted into a LIST and can
be retrieved by some functions
we will mention later.
Process(integer) - takes the timeout period as an argument. If no
timeout is listed then the function blocks until
a packet is received. Otherwise it waits that
number of seconds and then exits so your program
can continue doing useful things. NOTE: This is
important for GUIs. You need to leave time to
process GUI commands even if you are waiting for
packets.
Send(object) - takes either a Net::Jabber::xxxxx object or an XML
Send(string) string as an argument and sends it to the server.
Disconnect() - closes the connection to the server.ID Functions
SendWithID(object) - takes either a Net::Jabber::xxxxx object or an
SendWithID(string) XML string as an argument, adds the next
available ID number and sends that packet to
the server. Returns the ID number assigned.
SendAndReceiveWithID(object) - uses SendWithID and WaitForID to
SendAndReceiveWithID(string) provide a complete way to send and
receive packets with IDs. Can take
either a Net::Jabber::xxxxx object
or an XML string. Returns the
proper Net::Jabber::xxxxx object
based on the type of packet received.
ReceivedID(integer) - returns 1 if a packet has been received with
specified ID, 0 otherwise.
GetID(integer) - returns the proper Net::Jabber::xxxxx object based
on the type of packet received with the specified
ID. If the ID has been received the GetID returns
0.
WaitForID(integer) - blocks until a packet with the ID is received.
Returns the proper Net::Jabber::xxxxx object
based on the type of packet received
IgnoreIDs() - tells the client to stop putting IDs in a seperate array
and just pass the object to the specified callback.
This is useful for writing a daemon to listen to a
Jabber account and respond back with an ID on
a <message/>.
WatchIDs() - tells the client to start putting IDs in a seperate array
and not pass the object to the specified callback. If
you call IgnoreIDs(), this function turns ID handling
back on.Message Functions
MessageSend(hash) - takes the hash and passes it to SetMessage in
Net::Jabber::Message (refer there for valid
settings). Then it sends the message to the
server.Presence Functions
#todo: document PresenceSend
IQ::Auth Functions
AuthSend(username=>string, - takes all of the information and
password=>string, builds a Net::Jabber::IQ::Auth packet.
resource=>string) It then sends that packet to the
AuthSend() server with an ID and waits for that
ID to return. Then it looks in
resulting packet and determines if
authentication was successful for not.
If no hash is passed then it tries
to open an anonymous session. The
array returned from AuthSend looks
like this:
[ type , message ]
If type is "ok" then authentication
was successful, otherwise message
contains a little more detail about the
error.IQ::Info Functions
n/aIQ::Register Functions
RegisterSend(username=>string, - takes all of the information and
password=>string, builds a Net::Jabber::IQ::Register
resource=>string) packet. It then sends that packet
to the server with an ID and waits
for that ID to return. Then it
looks in resulting packet and
determines if registration was
successful for not. The array
returned from RegisterSend looks
like this:
[ type , message ]
If type is "ok" then registration
was successful, otherwise message
contains a little more detail about the
error.IQ::Resource Functions
n/aIQ::Roster Functions
RosterGet() - sends an empty Net::Jabber::IQ::Roster tag to the
server so the server will send the Roster to the
client.
RosterAdd(jid=>string) - sends a packet asking that the jid be
added to the user's roster.
RosterRemove(jid=>string) - sends a packet asking that the jid be
removed from the user's roster.X Functions
SetXDelegates(hash) - the hash gets sent to the
Net::Jabber::X::SetDelegates function. For
more information about this function, read
the manpage for Net::Jabber::X.AUTHOR
Revised by Ryan Eatmon in December 1999.
By Thomas Charron in July of 1999 for http://jabber.org..
Based on a screenplay by Jeremie Miller in May of 1999 for http://jabber.org/
COPYRIGHT
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.