ePages 6.10 - DE_EPAGES/Core/API/Log4PerlFileAppender.pm

Package DE_EPAGES::Core::API::Log4PerlFileAppender

Appender with non-locking file access for Log4Perl.

Functions

encoding
fileName
flock
log
mode
new

encoding

Returns the character encoding for the log file (default: iso-8859-1).

Syntax
$encoding = $Appender->encoding;
Return
$encoding (string)
character encoding

fileName

Returns the filename (used by Log4Perl).

Syntax
$FileName = $Appender->fileName;
Return
$FileName (string)
log file name

flock

Returns the flock mode (default 2).

Syntax
$flock = $Appender->flock;
Return
$flock (integer)
flock mode

log

Logs an event to the log file with temporary flock (used by Log4Perl).

Syntax
$Appender->log( message => $Message );
Input
$Message (string)
log message

mode

Returns the open mode for the log file (default append).

Syntax
$mode = $Appender->mode;
Return
$mode (string)
file open mode

new

Creates a new appender object.

Syntax
$Appender = DE_EPAGES::Core::API::Log4PerlFileAppender(
    filename => $FileName,
    mode => $Mode,
    flock => $Flock,
    encoding => $Encoding,
);
Input
$FileName (string)
log file name
$Name (string)
apppender name (optional, default: 'unknown name')
$Mode (string)
file open mode (append,write) (optional, default: 'append')
$Flock (integer)
flock mode (optional, default: 2)
$Encoding (integer)
character encoding (optional, default: 'iso-8859-1')
Return
$Appender (object)
appender object, see perldoc Log4perl