.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Log::Report::Dispatcher::Callback 3"
.TH Log::Report::Dispatcher::Callback 3 2025-12-12 "perl v5.42.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
Log::Report::Dispatcher::Callback \- call a code\-ref for each log\-line
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 2
\& Log::Report::Dispatcher::Callback
\&   is a Log::Report::Dispatcher
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&  sub cb($$$)
\&  {   my ($disp, $options, $reason, $message) = @_;
\&      ...
\&  }
\&
\&  dispatcher Log::Report::Dispatcher::Callback => \*(Aqcb\*(Aq,
\&        callback => \e&cb;
\&
\&  dispatcher CALLBACK => \*(Aqcb\*(Aq,   # same
\&        callback => \e&cb;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This basic file logger accepts a callback, which is called for each
message which is to be logged. When you need complex things, you
may best make your own extension to Log::Report::Dispatcher, but
for simple things this will do.
.PP
Extends "DESCRIPTION" in Log::Report::Dispatcher.
.PP
» Example
.IX Subsection "» Example"
.PP
.Vb 7
\&  sub send_mail($$$)
\&  {   my ($disp, $options, $reason, $message) = @_;
\&      my $msg = Mail::Send\->new(Subject => $reason, To => \*(Aqadmin@localhost\*(Aq);
\&      my $fh  = $msg\->open(\*(Aqsendmail\*(Aq);
\&      print $fh $disp\->translate($reason, $message);
\&      close $fh;
\&  }
\&
\&  dispatcher CALLBACK => \*(Aqmail\*(Aq, callback => \e&send_mail;
.Ve
.SH METHODS
.IX Header "METHODS"
Extends "METHODS" in Log::Report::Dispatcher.
.SS Constructors
.IX Subsection "Constructors"
Extends "Constructors" in Log::Report::Dispatcher.
.ie n .IP "$class\->\fBnew\fR($type, $name, %options)" 4
.el .IP "\f(CW$class\fR\->\fBnew\fR($type, \f(CW$name\fR, \f(CW%options\fR)" 4
.IX Item "$class->new($type, $name, %options)"
Inherited, see "Constructors" in Log::Report::Dispatcher
.Sp
.Vb 7
\& \-Option       \-\-Defined in             \-\-Default
\&  accept         Log::Report::Dispatcher  depend on mode
\&  callback                                <required>
\&  charset        Log::Report::Dispatcher  undef
\&  format_reason  Log::Report::Dispatcher  \*(AqLOWERCASE\*(Aq
\&  locale         Log::Report::Dispatcher  <system locale>
\&  mode           Log::Report::Dispatcher  \*(AqNORMAL\*(Aq
.Ve
.RS 4
.ie n .IP "accept => $reasons|\e@reasons" 2
.el .IP "accept => \f(CW$reasons\fR|\e@reasons" 2
.IX Item "accept => $reasons|@reasons"
.PD 0
.IP "callback => CODE" 2
.IX Item "callback => CODE"
.PD
Your \f(CW\*(C`callback\*(C'\fR is called with five parameters: this dispatcher object,
the options, a reason and a message.  The \f(CW\*(C`options\*(C'\fR are the first
parameter of \fBLog::Report::report()\fR (read over there).  The \f(CW\*(C`reason\*(C'\fR
is a capitized string like \f(CW\*(C`ERROR\*(C'\fR. Then, the \f(CW\*(C`message\*(C'\fR (is a
Log::Report::Message).  Finally the text\-domain of the message.
.IP "charset => CHARSET" 2
.IX Item "charset => CHARSET"
.PD 0
.IP "format_reason => \*(AqUPPERCASE\*(Aq|\*(AqLOWERCASE\*(Aq|\*(AqUCFIRST\*(Aq|\*(AqIGNORE\*(Aq|CODE" 2
.IX Item "format_reason => 'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE"
.IP "locale => LOCALE" 2
.IX Item "locale => LOCALE"
.IP "mode => \*(AqNORMAL\*(Aq|\*(AqVERBOSE\*(Aq|\*(AqASSERT\*(Aq|\*(AqDEBUG\*(Aq|0..3" 2
.IX Item "mode => 'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3"
.PD
.RE
.RS 4
.RE
.SS Accessors
.IX Subsection "Accessors"
Extends "Accessors" in Log::Report::Dispatcher.
.ie n .IP $obj\->\fBcallback\fR() 4
.el .IP \f(CW$obj\fR\->\fBcallback\fR() 4
.IX Item "$obj->callback()"
Returns the code reference which will handle each logged message.
.ie n .IP $obj\->\fBisDisabled\fR() 4
.el .IP \f(CW$obj\fR\->\fBisDisabled\fR() 4
.IX Item "$obj->isDisabled()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBmode\fR() 4
.el .IP \f(CW$obj\fR\->\fBmode\fR() 4
.IX Item "$obj->mode()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBname\fR() 4
.el .IP \f(CW$obj\fR\->\fBname\fR() 4
.IX Item "$obj->name()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBneeds\fR( [$reason] )" 4
.el .IP "\f(CW$obj\fR\->\fBneeds\fR( [$reason] )" 4
.IX Item "$obj->needs( [$reason] )"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBtype\fR() 4
.el .IP \f(CW$obj\fR\->\fBtype\fR() 4
.IX Item "$obj->type()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.SS Logging
.IX Subsection "Logging"
Extends "Logging" in Log::Report::Dispatcher.
.ie n .IP $any\->\fBaddSkipStack\fR(@CODE) 4
.el .IP \f(CW$any\fR\->\fBaddSkipStack\fR(@CODE) 4
.IX Item "$any->addSkipStack(@CODE)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBclose\fR() 4
.el .IP \f(CW$obj\fR\->\fBclose\fR() 4
.IX Item "$obj->close()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $any\->\fBcollectLocation\fR() 4
.el .IP \f(CW$any\fR\->\fBcollectLocation\fR() 4
.IX Item "$any->collectLocation()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$any\->\fBcollectStack\fR( [$maxdepth] )" 4
.el .IP "\f(CW$any\fR\->\fBcollectStack\fR( [$maxdepth] )" 4
.IX Item "$any->collectStack( [$maxdepth] )"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBlog\fR(\e%options, $reason, $message, $domain)" 4
.el .IP "\f(CW$obj\fR\->\fBlog\fR(\e%options, \f(CW$reason\fR, \f(CW$message\fR, \f(CW$domain\fR)" 4
.IX Item "$obj->log(%options, $reason, $message, $domain)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBskipStack\fR() 4
.el .IP \f(CW$obj\fR\->\fBskipStack\fR() 4
.IX Item "$obj->skipStack()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $any\->\fBstackTraceLine\fR(%options) 4
.el .IP \f(CW$any\fR\->\fBstackTraceLine\fR(%options) 4
.IX Item "$any->stackTraceLine(%options)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBtranslate\fR(\e%options, $reason, $message)" 4
.el .IP "\f(CW$obj\fR\->\fBtranslate\fR(\e%options, \f(CW$reason\fR, \f(CW$message\fR)" 4
.IX Item "$obj->translate(%options, $reason, $message)"
Inherited, see "Logging" in Log::Report::Dispatcher
.SH DETAILS
.IX Header "DETAILS"
Extends "DETAILS" in Log::Report::Dispatcher.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.ie n .IP "Error: dispatcher $name needs a \*(Aqcallback\*(Aq" 4
.el .IP "Error: dispatcher \f(CW$name\fR needs a \*(Aqcallback\*(Aq" 4
.IX Item "Error: dispatcher $name needs a 'callback'"
Cast by \f(CWnew()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log\-Report version 1.43,
built on December 05, 2025. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2007\-2025 by Mark Overmeer.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.