net::xmpp::debug(3pm) [debian man page]

Net::XMPP::Debug(3pm)					User Contributed Perl Documentation				     Net::XMPP::Debug(3pm)

NAME

       Net::XMPP::Debug - XMPP Debug Module

SYNOPSIS

	 Net::XMPP::Debug is a module that provides a developer easy access
	 to logging debug information.

DESCRIPTION

	 Debug is a helper module for the Net::XMPP modules.  It provides
	 the Net::XMPP modules with an object to control where, how, and
	 what is logged.

   Basic Functions
	   $Debug = new Net::XMPP::Debug();

	   $Debug->Init(level=>2,
			    file=>"stdout",
			    header=>"MyScript");

	   $Debug->Log0("Connection established");

METHODS

   Basic Functions
	   new(hash) - creates the Debug object.  The hash argument is passed
		       to the Init function.  See that function description
		       below for the valid settings.

	   Init(level=>integer,  - initializes the debug object.  The level
		file=>string,	   determines the maximum level of debug
		header=>string,    messages to log:
		setdefault=>0|1,     0 - Base level Output (default)
		usedefault=>0|1,     1 - High level API calls
		time=>0|1)	     2 - Low level API calls
				     ...
				     N - Whatever you want....
				   The file determines where the debug log
				   goes.  You can either specify a path to
				   a file, or "stdout" (the default).  "stdout"
				   tells Debug to send all of the debug info
				   sent to this object to go to stdout.
				   header is a string that will preappended
				   to the beginning of all log entries.  This
				   makes it easier to see what generated the
				   log entry (default is "Debug").
				   setdefault saves the current filehandle
				   and makes it available for other Debug
				   objects to use.  To use the default set
				   usedefault to 1.  The time parameter
				   specifies whether or not to add a timestamp
				   to the beginning of each logged line.

	   LogN(array) - Logs the elements of the array at the corresponding
			 debug level N.  If you pass in a reference to an
			 array or hash then they are printed in a readable
			 way.  (ie... Log0, Log2, Log100, etc...)

EXAMPLE

	 $Debug = new Net::XMPP:Debug(level=>2,
				      header=>"Example");

	   $Debug->Log0("test");

	   $Debug->Log2("level 2 test");

	   $hash{a} = "atest";
	   $hash{b} = "btest";

	   $Debug->Log1("hashtest",\%hash);

	 You would get the following log:

	   Example: test
	   Example: level 2 test
	   Example: hashtest { a=>"atest" b=>"btest" }

	 If you had set the level to 1 instead of 2 you would get:

	   Example: test
	   Example: hashtest { a=>"atest" b=>"btest" }

AUTHOR

       Ryan Eatmon

COPYRIGHT

       This module is free software, you can redistribute it and/or modify it under the LGPL.

perl v5.14.2							    2012-11-06						     Net::XMPP::Debug(3pm)

Net::XMPP::JID(3pm)					User Contributed Perl Documentation				       Net::XMPP::JID(3pm)

NAME

       Net::XMPP::JID - XMPP JID Module

SYNOPSIS

	 Net::XMPP::JID is a companion to the Net::XMPP module.
	 It provides the user a simple interface to set and retrieve all
	 parts of a Jabber ID (userid on a server).

DESCRIPTION

	 To initialize the JID you must pass it the string that represents the
	 jid from the XML packet.  Inside the XMPP modules this is done
	 automatically and the JID object is returned instead of a string.
	 For example, in the callback function for the XMPP object foo:

	   use Net::XMPP;

	   sub foo {
	     my $foo = new Net::XMPP::Foo(@_);
	     my $from = $foo->GetFrom();
	     my $JID = new Net::XMPP::JID($from);
	     .
	     .
	     .
	   }

	 You now have access to all of the retrieval functions available.

	 To create a new JID to send to the server:

	   use Net::XMPP;

	   $JID = new Net::XMPP::JID();

	 Now you can call the creation functions below to populate the tag
	 before sending it.

   Retrieval functions
	   $userid   = $JID->GetUserID();
	   $server   = $JID->GetServer();
	   $resource = $JID->GetResource();

	   $JID      = $JID->GetJID();
	   $fullJID  = $JID->GetJID("full");
	   $baseJID  = $JID->GetJID("base");

   Creation functions
	   $JID->SetJID(userid=>"bob",
			server=>"jabber.org",
			resource=>"Work");

	   $JID->SetJID('blue@moon.org/Home');

	   $JID->SetUserID("foo");
	   $JID->SetServer("bar.net");
	   $JID->SetResource("Foo Bar");

METHODS

   Retrieval functions
	 GetUserID() - returns a string with the userid of the JID.
		       If the string is an address (bob%jabber.org) then
		       the function will return it as an address
		       (bob@jabber.org).

	 GetServer() - returns a string with the server of the JID.

	 GetResource() - returns a string with the resource of the JID.

	 GetJID()	- returns a string that represents the JID stored
	 GetJID("full")   within.  If the "full" string is specified, then
	 GetJID("base")   you get the full JID, including Resource, which
			  should be used to send to the server.  If the "base",
			  string is specified, then you will just get
			  user@server, or the base JID.

   Creation functions
	 SetJID(userid=>string,   - set multiple fields in the jid at
		server=>string,     one time.  This is a cumulative
		resource=>string)   and over writing action.  If you set
	 SetJID(string) 	    the "userid" attribute twice, the second
				    setting is what is used.  If you set
				    the server, and then set the resource
				    then both will be in the jid.  If all
				    you pass is a string, then that string
				    is used as the JID.  For valid settings
				    read the specific Set functions below.

	 SetUserID(string) - sets the userid.  Must be a valid userid or the
			     server will complain if you try to use this JID
			     to talk to the server.  If the string is an
			     address then it will be converted to the %
			     form suitable for using as a User ID.

	 SetServer(string) - sets the server.  Must be a valid host on the
			     network or the server will not be able to talk
			     to it.

	 SetResource(string) - sets the resource of the userid to talk to.

AUTHOR

       Ryan Eatmon

COPYRIGHT

       This module is free software, you can redistribute it and/or modify it under the LGPL.

perl v5.14.2							    2012-11-06						       Net::XMPP::JID(3pm)