Thomas Bolioli > Log-AndError-1.01 > Log::AndError

Download:
Log-AndError-1.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.01   Source  

NAME ^

Log::AndError - Logging module for ISA inclusion in other modules or as a standalone module.

SYNOPSIS ^

        use Log::AndError;
        @ISA = qw(Log::AndError);
                Remember to set values with the provided methods
        or
        use Log::AndError;
        use Log::AndError::Constants qw(:all);
        my $ref_logger = Log::AndError->new(
                'LOG_LOGGER' => \&log_sub,
                'LOG_SERVICE_NAME' => 'GENERIC', # Use this to seperate log entries from different modules in your app.
                'LOG_DEBUG_LEVEL'  =>  DEBUG1, # See Log::AndError::Constants for example
                'LOG_INFO_LEVEL' => INFO, # See Log::AndError::Constants for example
                'LOG_ALWAYSLOG_LEVEL' => ALWAYSLOG, # See Log::AndError::Constants for example
        );

        $self->logger(DEBUG3, 'my_sub('.join(',',@_).')'); 
                # for instance logs the entry into a subroutine.
        $self->logger(ALWAYSLOG, 'Something is wrong'); 
                # logs an error when it is always wanted

        After you do this:
                $self->error($error_code, $error_msg);
        Your Caller does this:
                my($err,$msg) = $obj_ref->error();
        to retrieve the errors.

DESCRIPTION ^

This is a generic log and error class for Perl modules. There are two distinct pieces here. The error functions and the logging. The error functions are most convenient when inherited by your package although this is not needed. They are mostly here for convenience and to promote "good" behavior. The logging functions are the more complex piece and is the bulk of the code.

To use the logging function pass in a reference to an anonymous sub routine that directs the error output to where you want it to go. There are a few sample subs located under this class. The default outputs to STDERR via warn().

The DEBUG constants are always >=0 and the ALWAYSLOG and INFO type constants always need to be <= -2 (-1 == undef on most systems). See Log::AndError::Constants for an example.

Examples forthcoming at some point.

Hey, it beats overwriting %SIG{__WARN__} with an anonymous sub for error string grabbing.

METHODS ^

service_name()

Log::AndError::service_name()

Usage:
        $service_name = $obj_ref->service_name(); #From Caller's Perspective
        or
        $self->service_name('GENERIC');
Purpose:

Gets or sets the currently used service name. The default is in the POD above and can be retrieved at runtime from the return value.

Returns:

($service_name) if set.

debug_level()

Log::AndError::debug_level()

Usage:
        $debug = $obj_ref->debug_level();  #From Caller's Perspective
        or
        $self->debug_level(1);
Purpose:

Sets or gets the debug level. Should be >= 0. If you decide against that then make sure you know what you are doing and info/alwayslog do not interfere. The default is in the POD above and can be retrieved at runtime from the return value.

Returns:

($debug_level) if set.

info_level()

Log::AndError::info_level()

Usage:
        $info_level = $obj_ref->info_level();  #From Caller's Perspective
        or
        $self->info_level(INFO); # -2 from Log::AndError::Constants
Purpose:

Sets or gets the info debug level. Should be <= -2. If you decide against that then make sure you know what you are doing and info/alwayslog do not interfere. The default is in the POD above and can be retrieved at runtime from the return value.

Returns:

($info_level) if set.

alwayslog_level()

Log::AndError::alwayslog_level()

Usage:
        $alwayslog_level = $obj_ref->alwayslog_level();  #From Caller's Perspective
        or
        $self->alwayslog_level(ALWAYSLOG); # -3 from Log::AndError::Constants
Purpose:

Sets or gets the alwayslog level. Should be <= -2. If you decide against that then make sure you know what you are doing and info/alwayslog do not interfere. The default is in the POD above and can be retrieved at runtime from the return value.

Returns:

($alwayslog_level) if set.

template()

Log::AndError::template()

Usage:
        my $template = $obj_ref->template();  #From Caller's Perspective
        or 
       my $template = $self->template("%s: LEVEL[%d]: %s");
Purpose:

This is a method for setting the sprintf() template for the logging method. It must have a %s(string), %d(decimal), %s(string) format to it. What you place in between is up to you. The default is in the POD above and can be retrieved at runtime from the return value.

Returns:

($template) if set and passes syntax test.

error()

Log::AndError::error()

Usage:
        my($err,$msg) = $obj_ref->error();  #From Caller's Perspective
        or 
        $self->error($error_code, $error_msg);
Purpose:

This is a wrapper for the error_code() and error_msg() functions. Remember that this is most useful when inherited by your module via ISA.

Returns:

($err, $msg) Values are up to you. See Message for details

error_code()

Log::AndError::error_code()

Usage:
        $err = $obj_ref->error_code();  #From Caller's Perspective
        or 
        $self->error_code($code);
Purpose:

Sets or gets the last error code encountered. Remember that this is most useful when inherited by your app via ISA.

Returns:

($err) Values are up to you.

error_msg()

Log::AndError::error_msg()

Usage:
        $msg = $obj_ref->error_msg();  #From Caller's Perspective
        or
        $self->error_msg($msg);
Purpose:

Sets or gets the textual description of last error. Remmber that this is most useful when inherited by your app via ISA.

Returns:

($msg) Values are up to you.

logger()

Log::AndError::logger()

Usage:
        my($err, $msg) = $self->logger(DEBUG_CONSTANT, $msg);
Purpose:

Logs messages.

Returns:

($err, $msg) undef is OK. Everything else > 0 is an error. See Message for details

HISTORY ^

See Changes file in distribution.

TODO ^

AUTHOR ^

Thomas Bolioli <Thomas_Bolioli@alumni.adelphi.edu>

THANKS ^

Thanks to John Ballem of Brown University for the Constants module and the push to do this one.

COPYRIGHT ^

Copyright (c) 2001 Thomas Bolioli. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

syntax highlighting: