/ 
Log-Fine-0.15
River stage zero No dependents
/ Log::Fine::Handle

NAME

Log::Fine::Handle - Controls where to send logging output

SYNOPSIS

Sets up an output handle for log messages

use Log::Fine;
use Log::Fine::Handle;

# instantiate the handle (default values shown)
my $handle = Log::Fine::Handle::Foo
    ->new( name      => "foo0",
           mask      => Log::Fine::Handle->DEFAULT_LOGMASK,
           level     => DEBG,
           formatter => Log::Fine::Formatter:Basic->new() );

# see if a handle is loggable at a given level
my $rc = $handle->isLoggable(INFO);

# write a message
$handle->msgWrite(INFO, "Informational message", 1);

DESCRIPTION

A Log::Fine::Handle object controls where to send formatted log messages. The destination can be a file, syslog, a database table, or simply to output. Message formatting is then handled by a formatter object.

METHODS

isLoggable($lvl)

Specifies whether the handle is loggable at the given level. Returns 1 if we can log, undef otherwise.

msgWrite($lvl, $msg, $skip)

Tells the handle to output the given log message. The third parameter, $skip, is passed to caller() for accurate method logging.

Note: msgWrite() is an internal method to the Log::Fine framework, meant to be sub-classed. Use "log($lvl, $msg)" in Log::Fine::Logger for actual logging.

setFormatter($formatter)

Sets the formatter for this object

SEE ALSO

perl, Log::Fine, Log::Fine::Formatter

AUTHOR

Christopher M. Fuhrman, <cfuhrman at panix.com>

BUGS

Please report any bugs or feature requests to bug-log-fine-handle at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Log-Fine. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Log::Fine

You can also look for information at:

REVISION INFORMATION

$Id: Handle.pm 82 2008-07-02 22:11:44Z cfuhrman $

COPYRIGHT & LICENSE

Copyright (c) 2008 Christopher M. Fuhrman, All rights reserved.

This program is free software licensed under the...

The BSD License

The full text of the license can be found in the LICENSE file included with this module.