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


Log-Fine documentation  | view source Contained in the Log-Fine distribution.

Index


NAME

Top

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

SYNOPSIS

Top

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

Top

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

Top

formatter

Getter/Setter for the objects formatter attribute

Parameters

* formatter

[optional] A valid Log::Fine::Formatter object

Returns

A Log::Fine::Formatter 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 Log::Fine::Logger for actual logging.

Parameters

* level

Level at which to log

* message

Message to log

* skip

Passed to caller (caller in perlfunc) for accurate method logging

Returns

None

BUGS

Top

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

Top

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

    perldoc Log::Fine

You can also look for information at:

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/Log-Fine

* CPAN Ratings

http://cpanratings.perl.org/d/Log-Fine

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Log-Fine

* Search CPAN

http://search.cpan.org/dist/Log-Fine

REVISION INFORMATION

Top

  $Id: b80416da666abcc143c7915744a4d61315ecc81a $

AUTHOR

Top

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

SEE ALSO

Top

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

COPYRIGHT & LICENSE

Top


Log-Fine documentation  | view source Contained in the Log-Fine distribution.