Net::XMPP::Debug(3) User Contributed Perl Documentation Net::XMPP::Debug(3)NAMENet::XMPP::Debug - XMPP Debug Module
SYNOPSISNet::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.10.0 2011-08-25 Net::XMPP::Debug(3)
