/ 
Net-Jabber-1.0023
River stage one • 5 direct dependents • 5 total dependents
/ Net::Jabber::Client

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 uses Protocol.pm 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.

For a full list of high level functions available please see
Net::Jabber::Protocol.

Basic Functions

use Net::Jabber qw(Client);

$Con = new Net::Jabber::Client();

$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(debuglevel=>0|1|2, - creates the Client object.  debugfile
        debugfile=>string,   should be set to the path for the debug
        debugtime=>0|1)      log to be written.  If set to "stdout"
                             then the debug will go there.  debuglevel
                             controls the amount of debug.  For more
                             information about the valid setting for
                             debuglevel, debugfile, and debugtime see
                             Net::Jabber::Debug.

    Connect(hostname=>string,      - opens a connection to the server
	    port=>integer,           listed in the hostname (default
            connectiontype=>string,  localhost), on the port (default
            ssl=>0|1)                5222) listed, using the
                                     connectiontype listed (default
                                     tcpip).  The two connection types
                                     available are:
                                       tcpip  standard TCP socket
                                       http   TCP socket, but with the
                                              headers needed to talk
                                              through a web proxy
                                     If you specify ssl, then it will
                                     be used to connect.

    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.