METHODS

Constructors

$class->new( TYPE, NAME, OPTIONS )
Option Defined in Default

accept

Log::Report::Dispatcher

depend on mode

charset

Log::Report::Dispatcher

LOCALE

format

<adds timestamp>

format_reason

Log::Report::Dispatcher

'LOWERCASE'

locale

Log::Report::Dispatcher

<system locale>

mode

Log::Report::Dispatcher

'NORMAL'

replace

false

to

<required>

accept => REASONS
charset => CHARSET
format => CODE
[1.00] process each printed line. By default, this adds a timestamp, but you may want to add hostname, process number, or more.
   format => sub { '['.localtime().'] '.$_[0] }
   format => sub { shift }   # no timestamp
   format => sub { strftime("[%FT%T $$] ", gmtime).shift }
The first parameter to format is the string to print. It is already translated and trailed by a newline.
format_reason => 'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE
locale => LOCALE
mode => 'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3
replace => BOOLEAN
Only used in combination with a FILENAME: throw away the old file if it exists. Probably you wish to append to existing information.
Use the LOCALE setting by default, which is LC_CTYPE or LC_ALL or LANG (in that order). If these contain a character-set which Perl understands, then that is used, otherwise silently ignored.
to => FILENAME|FILEHANDLE|OBJECT
You can either specify a FILENAME, which is opened in append mode with autoflush on. Or pass any kind of FILE-HANDLE or some OBJECT which implements a print() method. You probably want to have autoflush enabled on your FILE-HANDLES.
When cleaning-up the dispatcher, the file will only be closed in case of a FILENAME.

Accessors

$obj->filename

Returns the name of the opened file, or undef in case this dispatcher was started from a file-handle or file-object.

$obj->format
$obj->isDisabled
See isDisabled in Log::Report::Dispatcher.
$obj->mode
See mode in Log::Report::Dispatcher.
$obj->name
See name in Log::Report::Dispatcher.
$obj->needs( [REASON] )
See needs in Log::Report::Dispatcher.
$obj->output
$obj->type
See type in Log::Report::Dispatcher.

File maintenance

$obj->close

Only when initiated with a FILENAME, the file will be closed. In any other case, nothing will be done.

$obj->rotate( FILENAME )

[1.00] Move the current file to FILENAME, and start a new file.

Logging

$obj->collectLocation
$class->collectLocation
See collectLocation in Log::Report::Dispatcher.
$obj->collectStack( [MAXDEPTH] )
$class->collectStack( [MAXDEPTH] )
See collectStack in Log::Report::Dispatcher.
$obj->log( HASH-of-OPTIONS, REASON, MESSAGE )
See log in Log::Report::Dispatcher.
$obj->stackTraceLine( OPTIONS )
$class->stackTraceLine( OPTIONS )
See stackTraceLine in Log::Report::Dispatcher.
$obj->translate( HASH-of-OPTIONS, REASON, MESSAGE )
See translate in Log::Report::Dispatcher.