.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Server::Log::Log::Log4perl 3"
.TH Net::Server::Log::Log::Log4perl 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::Server::Log::Log::Log4perl \- log via Log4perl
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use base qw(Net::Server::PreFork);
\&
\&    _\|_PACKAGE_\|_\->run(
\&        log_file => \*(AqLog::Log4perl\*(Aq,
\&        log4perl_conf => \*(Aq/path/to/my/log4perl.conf\*(Aq,
\&        log4perl_logger => \*(Aqmyapp\*(Aq,
\&    );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides Log::Log4perl style logging to the Net::Server
system.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
.IP log_file 4
.IX Item "log_file"
To begin using Log::Log4perl logging, simply set the Net::Server
log_file configuration parameter to "Log::Log4perl".
.Sp
If the magic name "Log::Log4perl" is used, all logging will be
directed to the Log4perl system.  If used, the \f(CW\*(C`log4perl_conf\*(C'\fR,
\&\f(CW\*(C`log4perl_poll\*(C'\fR, \f(CW\*(C`log4perl_logger\*(C'\fR may also be defined.
.IP log4perl_conf 4
.IX Item "log4perl_conf"
Only available if \f(CW\*(C`log_file\*(C'\fR is equal to "Log::Log4perl".  This is
the filename of the log4perl configuration file \- see
Log::Log4perl. If this is not set, will die on startup. If the file
is not readable, will die.
.IP log4perl_poll 4
.IX Item "log4perl_poll"
If set to a value, will initialize with Log::Log4perl::init_and_watch
with this polling value. This can also be the string "HUP" to re-read
the log4perl_conf when a HUP signal is received. If set to 0, no
polling is done. See Log::Log4perl for more details.
.IP log4perl_logger 4
.IX Item "log4perl_logger"
This is the facility name. Defaults to "Net::Server".
.SH "DEFAULT ARGUMENTS FOR Net::Server"
.IX Header "DEFAULT ARGUMENTS FOR Net::Server"
The following arguments are available in the default \f(CW\*(C`Net::Server\*(C'\fR or
\&\f(CW\*(C`Net::Server::Single\*(C'\fR modules.  (Other personalities may use
additional parameters and may optionally not use parameters from the
base class.)
.PP
.Vb 1
\&    Key               Value                    Default
\&
\&    ## log4perl parameters (if log_file eq Log::Log4perl)
\&    log4perl_conf     "filename"               will die if not set
\&    log4perl_poll     number or HUP            0 (no polling)
\&    log4perl_logger   "name"                   "Net::Server"
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .IP """initialize""" 4
.el .IP \f(CWinitialize\fR 4
.IX Item "initialize"
This method is called during the initilize_logging method of
Net::Server.  It returns a single code ref that will be stored under
the log_function property of the Net::Server object.  That code ref
takes log_level and message as arguments and calls the initialized
log4perl system.
.SH LICENCE
.IX Header "LICENCE"
Distributed under the same terms as Net::Server