Public Member Functions | Protected Member Functions | Protected Attributes
log4cpp::StringQueueAppender Class Reference

#include <StringQueueAppender.hh>

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

List of all members.

Public Member Functions

virtual void close ()
virtual std::queue< std::string > & getQueue ()
virtual const std::queue
< std::string > & 
getQueue () const
virtual std::string popMessage ()
virtual size_t queueSize () const
virtual bool reopen ()
 StringQueueAppender (const std::string &name)
virtual ~StringQueueAppender ()

Protected Member Functions

virtual void _append (const LoggingEvent &event)

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

Definition at line 26 of file StringQueueAppender.hh.


Constructor & Destructor Documentation

Definition at line 15 of file StringQueueAppender.cpp.

Definition at line 19 of file StringQueueAppender.cpp.


Member Function Documentation

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

Appends the LoggingEvent to the queue.

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

Implements log4cpp::AppenderSkeleton.

Definition at line 27 of file StringQueueAppender.cpp.

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

Implements log4cpp::AppenderSkeleton.

Definition at line 23 of file StringQueueAppender.cpp.

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

Return the queue to which the Appends adds messages.

Returns:
the message queue

Definition at line 35 of file StringQueueAppender.cpp.

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

Return the queue to which the Appends adds messages.

Returns:
the message queue

Definition at line 39 of file StringQueueAppender.cpp.

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

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

Returns:
the oldest log message

Definition at line 47 of file StringQueueAppender.cpp.

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

Return the current size of the message queue. Shorthand for getQueue().size().

Returns:
the queue size

Definition at line 43 of file StringQueueAppender.cpp.

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.

Definition at line 31 of file StringQueueAppender.cpp.


Member Data Documentation

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

Definition at line 68 of file StringQueueAppender.hh.


The documentation for this class was generated from the following files:


log4cpp
Author(s): Stephen Roderick, Bastiaan Bakker, Cedric Le Goater, Steve Ostlind, Marcel Harkema, Walter Stroebel, Glenn Scott and Tony Cheung.
autogenerated on Thu Jan 2 2014 11:35:02