Christopher M. Fuhrman > Log-Fine-0.59 > Log::Fine::Handle

Download:
Log-Fine-0.59.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source   Latest Release: Log-Fine-0.64

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 ^

bitmaskListEnabled

Gets a list of enabled bit masks

Returns

An array containing a list of strings representing bitmasks enabled for this handle

formatter

Getter/Setter for the objects formatter attribute

Parameters

Returns

A Log::Fine::Formatter object

isLoggable

Specifies whether the handle is loggable at the given level.

Parameters

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

Returns

None

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: eb682cd6d5b120525dc6ddae6dc44df5e0fbba48 $

AUTHOR ^

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

SEE ALSO ^

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

COPYRIGHT & LICENSE ^

Copyright (c) 2008, 2010-2011 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.

syntax highlighting: