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


Log-Log4perl documentation  | view source Contained in the Log-Log4perl distribution.

Index


NAME

Top

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

SYNOPSIS

Top

  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

Top

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 expeced 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

Top

COPYRIGHT AND LICENSE

Top


Log-Log4perl documentation  | view source Contained in the Log-Log4perl distribution.