NAME
Net::Jabber::Transport - Jabber Transport Library
SYNOPSIS
Net::Jabber::Transport is a module that provides a developer easy access
to tranports in the Jabber Instant Messaging protocol.
DESCRIPTION
Transport.pm seeks to provide enough high level APIs and automation of
the low level APIs that writing a Jabber Transport 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::Transport 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.
For a full list of high level functions available please see
Net::Jabber::Protocol.
Basic Functions
use Net::Jabber;
$Con = new Net::Jabber::Transport();
$Con->Connect(hostname=>"jabber.org");
if ($Con->Connected()) {
print "We are connected to the server...\n";
}
#
# For the list of available function see Net::Jabber::Protocol.
#
$Con->Disconnect();
METHODS
Basic Functions
new(debug=>string) - creates the Transport object. debug
debugfh=>FileHandle) should be set to the path for the debug
log to be written. If set to "stdout"
then the debug will go there. Also, you
can specify a filehandle that already
exists and use that.
Connect(hostname=>string, - opens a connection to the server
port=>integer, listedt in the hostname value,
secret=>string, on the port listed. The defaults
transportname=>string) for the two are localhost and 5222.
The secret is the password needed
to attach the hostname, and the
transportname is the name that
server and clients will know the
transport by.
Disconnect() - closes the connection to the server.
Connected() - returns 1 if the Transport is connected to the server,
and 0 if not.
AUTHOR
By Ryan Eatmon in May of 2000 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.