NAME¶
Paranoid::Log::Buffer - Log Buffer Functions
VERSION¶
$Id: Buffer.pm,v 0.83 2010/06/03 19:03:46 acorliss Exp $
SYNOPSIS¶
use Paranoid::Log;
enableFacility('events', 'buffer', 'debug', '+');
enableFacility('more-events', 'buffer', 'debug', '+', 100);
@messages = Paranoid::Log::Buffer::dump($name);
DESCRIPTION¶
This module implements named buffers to be used for logging purposes. Each
buffer is of a concrete size (definable by the developer) with a max message
length of 2KB. Each message is stored with a timestamp. Once the buffer hits
the maximun number of entries it begins deleting the oldest messages as the
new messages come in.
Buffers are created automatically on the fly, and messages trimmed before being
stored.
With the exception of the
dump function this module is not meant to be
used directly.
Paranoid::Log should be your exclusive interface for
logging.
When enabling a buffer facility with
Paranoid::Log you can add one
integral argument to the call. That number defines the size of the log buffer
in terms of number of entries allowed.
NOTE: Buffers are maintained within process memory. If you fork a process
from a parent with a log buffer each copy will maintain its own entries.
SUBROUTINES/METHODS¶
NOTE: Given that this module is not intended to be used directly nothing
is exported.
init¶
log¶
remove¶
Paranoid::Log::Buffer::dump¶
@entries = Paranoid::Log::Buffer::dump($name);
This dumps all current entries in the named buffer. Each entry is an array
reference to a two-element array. The first element is the timestamp of the
message (in UNIX epoch seconds), the second the actual message itself.
DEPENDENCIES¶
- o
- Paranoid::Debug
SEE ALSO¶
- o
- Paranoid::Log
BUGS AND LIMITATIONS¶
AUTHOR¶
Arthur Corliss (corliss@digitalmages.com)
LICENSE AND COPYRIGHT¶
This software is licensed under the same terms as Perl, itself. Please see
http://dev.perl.org/licenses/ for more information.
(c) 2005, Arthur Corliss (corliss@digitalmages.com)