GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Agent::Tag::Callback(3) User Contributed Perl Documentation Agent::Tag::Callback(3)

Log::Agent::Tag::Callback - a dynamic tag string

 require Log::Agent::Tag::Callback;
 # Inherits from Log::Agent::Tag.

 my $tag = Log::Agent::Tag::Callback->make(
     -name      => "session id",
     -callback  => Callback->new($obj, 'method', @args),
     -postfix   => 1,
     -separator => " -- ",
 );

This class represents a dynamic tag string, whose value is determined by invoking a pre-determined callback, which is described by a "Callback" object.

You need to make your application depend on the "Callback" module from CPAN if you make use of this tagging feature, since "Log::Agent" does not depend on it, on purpose (it does not really use it, it only offers an interface to plug it in). At least version 1.02 must be used.

The following parameters are defined, in alphabetical order:
"-callback" => "Callback" object
The callback to invoke to determine the value of the tag. The call is protected via a busy flag, in case there is an unwanted recursion due to a call to one of the logging routines whilst within the callback.

If the callback is busy, the tag emitted is:

    callback "user" busy
    

assuming "user" is the name you supplied via "-name" for this tag.

"-name" => name
The name of this tag. Used to flag a callback as busy in case there is an unwanted recursion into the callback routine.
"-postfix" => flag
Whether tag should be placed after or before the log message. By default, it is prepended to the log message, i.e. this parameter is false.
"-separator" => string
The separation string between the tag and the log message. A single space by default.

Raphael Manfredi <Raphael_Manfredi@pobox.com>

Callback(3), Log::Agent::Tag(3), Log::Agent::Message(3).
2021-04-12 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.