/ 
Paranoid-0.16
River stage one • 5 direct dependents • 9 total dependents
/ Paranoid::Log::Template

NAME

Paraniod::Log::Template - Log Facility Template

MODULE VERSION

$Id: Template.pm,v 0.3 2008/02/27 06:51:08 acorliss Exp $

SYNOPSIS

use Paranoid::Log::Template;

$rv = init();
$rv = remove($name);

$rv = log($msgtime, $severity, $message, $name, $facility, $level, $scope,
          @args);

@entries = dump($name);

REQUIREMENTS

Paranoid::Debug

DESCRIPTION

This is a template for logging facilities which can be used by Paranoid::Log. The functions above are the minimum required for proper operation. For specific examples please see the actual facilities bundled with the the Paranoid modules.

These modules are typically not meant to be used directly, but through the Paranoid::Log interface only.

FUNCTIONS

init

$rv = init();

This function is called the first time a logging facility is activated. You can use it to initialize an internal data structures necessary for proper operation.

remove

$rv = remove($name);

This function is called to deactivate a named instance of the logging facility.

log

$rv = log($msgtime, $severity, $message, $name, $facility, $level, $scope,
          @args);

This function causes the passed message to be logged to whatever the named instance represents. This is a blocking call.

dump

@entries = dump($name);

This is currently only useful for ring buffers, in which case it dumps the current contents of the buffer into an array and returns it. All facilities that do not support this should simply return an empty list.

SEE ALSO

Paranoid::Log(3)

HISTORY

None as of yet.

AUTHOR/COPYRIGHT

(c) 2005 Arthur Corliss (corliss@digitalmages.com)