net::jabber::server(3pm) [debian man page]
Net::Jabber::Server(3pm) User Contributed Perl Documentation Net::Jabber::Server(3pm) 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. perl v5.14.2 2004-08-17 Net::Jabber::Server(3pm)
Check Out this Related Man Page
Net::Jabber::Dialback::Verify(3pm) User Contributed Perl Documentation Net::Jabber::Dialback::Verify(3pm) NAME
Net::Jabber::Dialback::Verify - Jabber Dialback Verify Module SYNOPSIS
Net::Jabber::Dialback::Verify is a companion to the Net::Jabber::Dialback module. It provides the user a simple interface to set and retrieve all parts of a Jabber Dialback Verify. DESCRIPTION
To initialize the Verify with a Jabber <db:*/> you must pass it the XML::Stream hash. For example: my $dialback = new Net::Jabber::Dialback::Verify(%hash); There has been a change from the old way of handling the callbacks. You no longer have to do the above yourself, a NJ::Dialback::Verify object is passed to the callback function for the message. Also, the first argument to the callback functions is the session ID from XML::Streams. There are some cases where you might want this information, like if you created a Client that connects to two servers at once, or for writing a mini server. use Net::Jabber qw(Server); sub dialbackVerify { my ($sid,$Verify) = @_; . . . } You now have access to all of the retrieval functions available. To create a new dialback to send to the server: use Net::Jabber qw(Server); $Verify = new Net::Jabber::Dialback::Verify(); Now you can call the creation functions below to populate the tag before sending it. For more information about the array format being passed to the CallBack please read the Net::Jabber::Client documentation. Retrieval functions $to = $Verify->GetTo(); $from = $Verify->GetFrom(); $type = $Verify->GetType(); $id = $Verify->GetID(); $data = $Verify->GetData(); $str = $Verify->GetXML(); @dialback = $Verify->GetTree(); Creation functions $Verify->SetVerify(from=>"jabber.org", to=>"jabber.com", id=>id, data=>key); $Verify->SetTo("jabber.org"); $Verify->SetFrom("jabber.com"); $Verify->SetType("valid"); $Verify->SetID(id); $Verify->SetData(key); Test functions $test = $Verify->DefinedTo(); $test = $Verify->DefinedFrom(); $test = $Verify->DefinedType(); $test = $Verify->DefinedID(); METHODS
Retrieval functions GetTo() - returns a string with server that the <db:verify/> is being sent to. GetFrom() - returns a string with server that the <db:verify/> is being sent from. GetType() - returns a string with the type <db:verify/> this is. GetID() - returns a string with the id <db:verify/> this is. GetData() - returns a string with the cdata of the <db:verify/>. GetXML() - returns the XML string that represents the <db:verify/>. This is used by the Send() function in Server.pm to send this object as a Jabber Dialback Verify. GetTree() - returns an array that contains the <db:verify/> tag in XML::Parser::Tree format. Creation functions SetVerify(to=>string, - set multiple fields in the <db:verify/> from=>string, at one time. This is a cumulative type=>string, and over writing action. If you set id=>string, the "from" attribute twice, the second data=>string) setting is what is used. If you set the type, and then set the data then both will be in the <db:verify/> tag. For valid settings read the specific Set functions below. SetTo(string) - sets the to attribute. SetFrom(string) - sets the from attribute. SetType(string) - sets the type attribute. Valid settings are: valid invalid SetID(string) - sets the id attribute. SetData(string) - sets the cdata of the <db:verify/>. Test functions DefinedTo() - returns 1 if the to attribute is defined in the <db:verify/>, 0 otherwise. DefinedFrom() - returns 1 if the from attribute is defined in the <db:verify/>, 0 otherwise. DefinedType() - returns 1 if the type attribute is defined in the <db:verify/>, 0 otherwise. DefinedID() - returns 1 if the id attribute is defined in the <db:verify/>, 0 otherwise. AUTHOR
By Ryan Eatmon in May 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. perl v5.14.2 2004-08-17 Net::Jabber::Dialback::Verify(3pm)