Net::Jabber::Server - phpMan

NAME
    Net::Jabber::Server - Jabber Server Library

SYNOPSIS
      Net::Jabber::Server is a module that provides a developer easy access
      to developing applications that need an embedded Jabber server.

DESCRIPTION
      Server.pm seeks to provide enough high level APIs and automation of
      the low level APIs that writing and spawning a Jabber Server 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::Server provides functions to run a full Jabber server that
      accepts incoming connections and delivers packets to external Jabber
      servers.  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(Server);

        $Server = new Net::Jabber::Server();

        $Server->Start();
        $Server->Start(jabberxml=>"custom_jabber.xml",
                       hostname=>"foobar.net");

        %status = $Server->Process();
        %status = $Server->Process(5);

        $Server->Stop();

METHODS
  Basic Functions
        new(debuglevel=>0|1|2, - creates the Server 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.

        Start(hostname=>string, - starts the server listening on the proper
              jaberxml=>string)   ports.  hostname is a quick way of telling
                                  the server the hostname to listen on.
                                  jabberxml defines the path to a different
                                  jabberd configuration file (default is
                                  "./jabber.xml").

        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.  The following are the possible return
                           values for each hash entry, and what they mean:

                               1   - Status ok, data received.
                               0   - Status ok, no data received.
                             undef - Status not ok, stop processing.

                           IMPORTANT: You need to check the output of every
                           Process.  If you get an undef then the connection
                           died and you should behave accordingly.

        Stop() - stops the server from running and shuts down all sub programs.

AUTHOR
    By Ryan Eatmon in January of 2001 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.