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,
               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

formatter

Getter/Setter for the object's formatter attribute

Parameters

formatter
[optional] A valid the Log::Fine::Formatter manpage object

Returns

A the Log::Fine::Formatter manpage object

isLoggable

Specifies whether the handle is loggable at the given level.

Parameters

level
Name of level or numeric value representing level

Returns

1 if this level is loggable, undef otherwise

msgWrite

Tells the handle to output the given log message.

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

Parameters

level
Level at which to log
message
Message to log
skip
Passed to caller for accurate method logging

Returns

none

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. 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: 987f0391b999a2fdc2c9aa6d1d608050677daad3 $

COPYRIGHT & LICENSE

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.

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