log::dispatch::email(3) [suse man page]

Log::Dispatch::Email(3) 				User Contributed Perl Documentation				   Log::Dispatch::Email(3)

NAME

       Log::Dispatch::Email - Base class for objects that send log messages via email

SYNOPSIS

	 package Log::Dispatch::Email::MySender

	 use Log::Dispatch::Email;
	 use base qw( Log::Dispatch::Email );

	 sub send_email
	 {
	     my $self = shift;
	     my %p = @_;

	     # Send email somehow.  Message is in $p{message}
	 }

DESCRIPTION

       This module should be used as a base class to implement Log::Dispatch::* objects that send their log messages via email.  Implementing a
       subclass simply requires the code shown in the SYNOPSIS with a real implementation of the "send_email()" method.

CONSTRUCTOR

       The constructor takes the following parameters in addition to the standard parameters documented in Log::Dispatch::Output:

       o   subject ($)

	   The subject of the email messages which are sent.  Defaults to "$0: log email"

       o   to ($ or @)

	   Either a string or a list reference of strings containing email addresses.  Required.

       o   from ($)

	   A string containing an email address.  This is optional and may not work with all mail sending methods.

       o   buffered (0 or 1)

	   This determines whether the object sends one email per message it is given or whether it stores them up and sends them all at once.
	   The default is to buffer messages.

METHODS

       o   send_email(%p)

	   This is the method that must be subclassed.	For now the only parameter in the hash is 'message'.

       o   flush

	   If the object is buffered, then this method will call the "send_email()" method to send the contents of the buffer and then clear the
	   buffer.

       o   DESTROY

	   On destruction, the object will call "flush()" to send any pending email.

AUTHOR

       Dave Rolsky, <autarch@urth.org>

perl v5.12.1							    2009-09-22						   Log::Dispatch::Email(3)

Log::Dispatch::Output(3)				User Contributed Perl Documentation				  Log::Dispatch::Output(3)

NAME

       Log::Dispatch::Output - Base class for all Log::Dispatch::* objects

SYNOPSIS

	 package Log::Dispatch::MySubclass;

	 use Log::Dispatch::Output;
	 use base qw( Log::Dispatch::Output );

	 sub new
	 {
	     my $proto = shift;
	     my $class = ref $proto || $proto;

	     my %p = @_;

	     my $self = bless {}, $class;

	     $self->_basic_init(%p);

	     # Do more if you like

	     return $self;
	 }

	 sub log_message
	 {
	     my $self = shift;
	     my %p = @_;

	     # Do something with message in $p{message}
	 }

	 1;

DESCRIPTION

       This module is the base class from which all Log::Dispatch::* objects should be derived.

CONSTRUCTOR

       The constructor, "new", must be overridden in a subclass. See Output Classes for a description of the common parameters accepted by this
       constructor.

METHODS

       o   _basic_init(%p)

	   This should be called from a subclass's constructor.  Make sure to pass the arguments in @_ to it.  It sets the object's name and
	   minimum level.  It also sets up two other attributes which are used by other Log::Dispatch::Output methods, level_names and
	   level_numbers.

       o   name

	   Returns the object's name.

       o   min_level

	   Returns the object's minimum log level.

       o   max_level

	   Returns the object's maximum log level.

       o   accepted_levels

	   Returns a list of the object's accepted levels (by name) from minimum to maximum.

       o   log( level => $, message => $ )

	   Sends a message if the level is greater than or equal to the object's minimum level.  This method applies any message formatting
	   callbacks that the object may have.

       o   _should_log ($)

	   This method is called from the "log()" method with the log level of the message to be logged as an argument.  It returns a boolean
	   value indicating whether or not the message should be logged by this particular object.  The "log()" method will not process the
	   message if the return value is false.

       o   _level_as_number ($)

	   This method will take a log level as a string (or a number) and return the number of that log level.  If not given an argument, it
	   returns the calling object's log level instead.  If it cannot determine the level then it will croak.

       o   add_callback( $code )

	   Adds a callback (like those given during construction). It is added to the end of the list of callbacks.

   Subclassing
       This class should be used as the base class for all logging objects you create that you would like to work under the Log::Dispatch
       architecture.  Subclassing is fairly trivial.  For most subclasses, if you simply copy the code in the SYNOPSIS and then put some
       functionality into the "log_message" method then you should be all set.	Please make sure to use the "_basic_init" method as directed.

       The actual logging implementation should be done in a "log_message" method that you write. Do not override "log"!.

AUTHOR

       Dave Rolsky, <autarch@urth.org>

perl v5.12.1							    2009-09-22						  Log::Dispatch::Output(3)