.\" -*- 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 "Appender::TestBuffer 3"
.TH Appender::TestBuffer 3 2023-07-25 "perl v5.38.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::Log4perl::Appender::TestBuffer \- Appender class for testing
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Log::Log4perl::Appender::TestBuffer;
\&
\&  my $appender = Log::Log4perl::Appender::TestBuffer\->new( 
\&      name      => \*(Aqmybuffer\*(Aq,
\&  );
\&
\&      # Append to the buffer
\&  $appender\->log( 
\&      level =  > \*(Aqalert\*(Aq, 
\&      message => "I\*(Aqm searching the city for sci\-fi wasabi\en" 
\&  );
\&
\&      # Retrieve the result
\&  my $result = $appender\->buffer();
\&
\&      # Clear the buffer to the empty string
\&  $appender\->clear();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class is used for internal testing of \f(CW\*(C`Log::Log4perl\*(C'\fR. It
is a \f(CW\*(C`Log::Dispatch\*(C'\fR\-style appender, which writes to a buffer 
in memory, from where actual results can be easily retrieved later
to compare with expected results.
.PP
Every buffer created is stored in an internal global array, and can
later be referenced by name:
.PP
.Vb 1
\&    my $app = Log::Log4perl::Appender::TestBuffer\->by_name("mybuffer");
.Ve
.PP
retrieves the appender object of a previously created buffer "mybuffer".
To reset this global array and have it forget all of the previously 
created testbuffer appenders (external references to those appenders
nonwithstanding), use
.PP
.Vb 1
\&    Log::Log4perl::Appender::TestBuffer\->reset();
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH LICENSE
.IX Header "LICENSE"
Copyright 2002\-2013 by Mike Schilli <m@perlmeister.com> 
and Kevin Goess <cpan@goess.org>.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH AUTHOR
.IX Header "AUTHOR"
Please contribute patches to the project on Github:
.PP
.Vb 1
\&    http://github.com/mschilli/log4perl
.Ve
.PP
Send bug reports or requests for enhancements to the authors via our
.PP
MAILING LIST (questions, bug reports, suggestions/patches): 
log4perl\-devel@lists.sourceforge.net
.PP
Authors (please contact them via the list above, not directly):
Mike Schilli <m@perlmeister.com>,
Kevin Goess <cpan@goess.org>
.PP
Contributors (in alphabetical order):
Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton
Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony
Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy
Grundman, Paul Harrington, Alexander Hartmaier  David Hull, 
Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter, 
Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope, 
Lars Thegler, David Viner, Mac Yang.