dwww Home | Manual pages | Find package

Appender::TestBuffer(3User Contributed Perl DocumentaAppender::TestBuffer(3pm)

NAME
       Log::Log4perl::Appender::TestBuffer - Appender class for testing

SYNOPSIS
         use Log::Log4perl::Appender::TestBuffer;

         my $appender = Log::Log4perl::Appender::TestBuffer->new(
             name      => 'mybuffer',
         );

             # Append to the buffer
         $appender->log(
             level =  > 'alert',
             message => "I'm searching the city for sci-fi wasabi\n"
         );

             # Retrieve the result
         my $result = $appender->buffer();

             # Clear the buffer to the empty string
         $appender->clear();

DESCRIPTION
       This class is used for internal testing of "Log::Log4perl". It is a
       "Log::Dispatch"-style appender, which writes to a buffer in memory,
       from where actual results can be easily retrieved later to compare with
       expected results.

       Every buffer created is stored in an internal global array, and can
       later be referenced by name:

           my $app = Log::Log4perl::Appender::TestBuffer->by_name("mybuffer");

       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

           Log::Log4perl::Appender::TestBuffer->reset();

SEE ALSO
LICENSE
       Copyright 2002-2013 by Mike Schilli <m@perlmeister.com> and Kevin Goess
       <cpan@goess.org>.

       This library is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

AUTHOR
       Please contribute patches to the project on Github:

           http://github.com/mschilli/log4perl

       Send bug reports or requests for enhancements to the authors via our

       MAILING LIST (questions, bug reports, suggestions/patches):
       log4perl-devel@lists.sourceforge.net

       Authors (please contact them via the list above, not directly): Mike
       Schilli <m@perlmeister.com>, Kevin Goess <cpan@goess.org>

       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.

perl v5.36.0                      2022-10-30         Appender::TestBuffer(3pm)

Generated by dwww version 1.15 on Sun Jun 30 23:25:28 CEST 2024.