Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

log4cpp::StringQueueAppender Class Reference

This class puts log messages in an in-memory queue. More...

#include <StringQueueAppender.hh>

Inheritance diagram for log4cpp::StringQueueAppender:

Inheritance graph
[legend]
Collaboration diagram for log4cpp::StringQueueAppender:

Collaboration graph
[legend]
List of all members.

Public Methods

 StringQueueAppender (const std::string &name)
virtual ~StringQueueAppender ()
virtual bool reopen ()
 Reopens the output destination of this Appender, e.g. More...

virtual void close ()
 Release any resources allocated within the appender such as file handles, network connections, etc.

virtual size_t queueSize () const
 Return the current size of the message queue. More...

virtual std::queue<std::string>& getQueue ()
 Return the queue to which the Appends adds messages. More...

virtual const std::queue<std::string>& getQueue () const
 Return the queue to which the Appends adds messages. More...

virtual std::string popMessage ()
 Pop the oldest log message from the front of the queue. More...


Protected Methods

virtual void _append (const LoggingEvent &event)
 Appends the LoggingEvent to the queue. More...


Protected Attributes

std::queue<std::string> _queue

Detailed Description

This class puts log messages in an in-memory queue.

Its primary use is in test cases, but it may be useful elsewhere as well.

Since:
0.2.4


Constructor & Destructor Documentation

log4cpp::StringQueueAppender::StringQueueAppender ( const std::string & name )
 

virtual log4cpp::StringQueueAppender::~StringQueueAppender ( ) [virtual]
 


Member Function Documentation

void log4cpp::StringQueueAppender::_append ( const LoggingEvent & event ) [protected, virtual]
 

Appends the LoggingEvent to the queue.

Parameters:
event   the LoggingEvent to layout and append to the queue.

Reimplemented from log4cpp::AppenderSkeleton.

virtual void log4cpp::StringQueueAppender::close ( ) [virtual]
 

Release any resources allocated within the appender such as file handles, network connections, etc.

Reimplemented from log4cpp::AppenderSkeleton.

const std::queue< std::string > & log4cpp::StringQueueAppender::getQueue ( ) const [virtual]
 

Return the queue to which the Appends adds messages.

Returns:
the message queue

std::queue< std::string > & log4cpp::StringQueueAppender::getQueue ( ) [virtual]
 

Return the queue to which the Appends adds messages.

Returns:
the message queue

std::string log4cpp::StringQueueAppender::popMessage ( ) [virtual]
 

Pop the oldest log message from the front of the queue.

Returns:
the oldest log message

size_t log4cpp::StringQueueAppender::queueSize ( ) const [virtual]
 

Return the current size of the message queue.

Shorthand for getQueue().size().

Returns:
the queue size

virtual bool log4cpp::StringQueueAppender::reopen ( ) [virtual]
 

Reopens the output destination of this Appender, e.g.

the logfile or TCP socket.

Returns:
false if an error occured during reopening, true otherwise.

Reimplemented from log4cpp::AppenderSkeleton.


Member Data Documentation

std::queue<std::string> log4cpp::StringQueueAppender::_queue [protected]
 


The documentation for this class was generated from the following file:
Generated at Mon Jun 11 01:25:25 2001 for log4cpp by doxygen1.2.6 written by Dimitri van Heesch, © 1997-2001