.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(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 "Paranoid::Log::Buffer 3pm"
.TH Paranoid::Log::Buffer 3pm 2024-03-07 "perl v5.38.2" "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
Paranoid::Log::Buffer \- Log Buffer Functions
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR lib/Paranoid/Log/Buffer.pm, 2.10 2022/03/08 00:01:04 acorliss Exp $
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Paranoid::Log;
\&  
\&  startLogger(\*(Aqevents\*(Aq, \*(AqBuffer\*(Aq, PL_DEBUG, PL_GE);
\&  startLogger(\*(Aqcrit\-events\*(Aq, \*(Aqbuffer\*(Aq, PL_CRIT, PL_EQ, { size => 100 });
\&
\&  @messages = Paranoid::Log::Buffer::dumpBuffer($name);
.Ve
.SH "DESCRIPTION k"
.IX Header "DESCRIPTION k"
This module implements named buffers to be used for logging purposes.
Each buffer is an fixed length array of message records.  Each message record
consists of a two-element array, with the first element being the message time
(in UNIX epoch seconds) and the second being the message text itself.
.PP
With the exception of the \fBdumpBuffer\fR function this module is not meant to 
be used directly.  \fBParanoid::Log\fR should be your exclusive interface for
logging.
.PP
When creating a named buffer with Paranoid::Log you can specify a size
option on a per-buffer basis.  The default size is 20.
.SH OPTIONS
.IX Header "OPTIONS"
The options recognized for use in the options hash are as follows:
.PP
.Vb 4
\&    Option      Value       Description
\&    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&    size        integer     number of entries to maintian 
\&                            in buffer
.Ve
.SH SUBROUTINES/METHODS
.IX Header "SUBROUTINES/METHODS"
\&\fBNOTE\fR:  Given that this module is not intended to be used directly nothing
is exported.
.SS init
.IX Subsection "init"
.SS logMsg
.IX Subsection "logMsg"
.SS addLogger
.IX Subsection "addLogger"
.SS delLogger
.IX Subsection "delLogger"
.SS dumpBuffer
.IX Subsection "dumpBuffer"
.Vb 1
\&  @entries = Paranoid::Log::Buffer::dumpBuffer($name);
.Ve
.PP
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.
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
.IP o 4
.IX Item "o"
Paranoid::Debug
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP o 4
.IX Item "o"
Paranoid::Log
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
.SH AUTHOR
.IX Header "AUTHOR"
Arthur Corliss (corliss@digitalmages.com)
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
This software is free software.  Similar to Perl, you can redistribute it
and/or modify it under the terms of either:
.PP
.Vb 7
\&  a)     the GNU General Public License
\&         <https://www.gnu.org/licenses/gpl\-1.0.html> as published by the 
\&         Free Software Foundation <http://www.fsf.org/>; either version 1
\&         <https://www.gnu.org/licenses/gpl\-1.0.html>, or any later version
\&         <https://www.gnu.org/licenses/license\-list.html#GNUGPL>, or
\&  b)     the Artistic License 2.0
\&         <https://opensource.org/licenses/Artistic\-2.0>,
.Ve
.PP
subject to the following additional term:  No trademark rights to
"Paranoid" have been or are conveyed under any of the above licenses.
However, "Paranoid" may be used fairly to describe this unmodified
software, in good faith, but not as a trademark.
.PP
(c) 2005 \- 2020, Arthur Corliss (corliss@digitalmages.com)
(tm) 2008 \- 2020, Paranoid Inc. (www.paranoid.com)