.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 "Event::RPC::Logger 3pm" .TH Event::RPC::Logger 3pm "2022-12-12" "perl v5.36.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" Event::RPC::Logger \- Logging facility for Event::RPC .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Event::RPC::Server; \& use Event::RPC::Logger; \& \& my $server = Event::RPC::Server\->new ( \& ... \& logger => Event::RPC::Logger\->new( \& filename => "/var/log/myserver.log", \& fh_lref => [ $fh, $sock ], \& min_level => 2, \& ), \& ... \& ); \& \& $server\->start; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This modules implements a simple logging facility for the Event::RPC framework. Log messages may be written to a specific file and/or a bunch of filehandles, which may be sockets as well. .SH "CONFIGURATION OPTIONS" .IX Header "CONFIGURATION OPTIONS" This is a list of options you can pass to the \fBnew()\fR constructor: .IP "\fBfilename\fR" 4 .IX Item "filename" All log messages are appended to this file. .IP "\fBfh_lref\fR" 4 .IX Item "fh_lref" All log messages are printed into this list of filehandles. .IP "\fBmin_level\fR" 4 .IX Item "min_level" This is the minimum log level. Output of messages with a lower level is suppressed. This option may be altered using \fBset_min_level()\fR even in a running server. .SH "METHODS" .IX Header "METHODS" .ie n .IP "$logger\->\fBlog\fR ( [$level, ] $msg )" 4 .el .IP "\f(CW$logger\fR\->\fBlog\fR ( [$level, ] \f(CW$msg\fR )" 4 .IX Item "$logger->log ( [$level, ] $msg )" The \fBlog()\fR method does the actual logging. Called with one argument the messages gets the default level of 1. With two argumens the first is the level for the message. .ie n .IP "$logger\->\fBadd_fh\fR ( $fh )" 4 .el .IP "\f(CW$logger\fR\->\fBadd_fh\fR ( \f(CW$fh\fR )" 4 .IX Item "$logger->add_fh ( $fh )" This adds a filehandle to the internal list of filhandles all log messages are written to. .ie n .IP "$logger\->\fBremove_fh\fR ( $fh )" 4 .el .IP "\f(CW$logger\fR\->\fBremove_fh\fR ( \f(CW$fh\fR )" 4 .IX Item "$logger->remove_fh ( $fh )" Removes a filehandle. .SH "AUTHORS" .IX Header "AUTHORS" .Vb 1 \& Jörn Reder .Ve .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2005\-2015 by Jörn Reder . .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.