StringQueueAppender Class Reference

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

#include <StringQueueAppender.hh>

Inheritance diagram for StringQueueAppender:

Public Member Functions
virtual void	close ()
	Release any resources allocated within the appender such as file handles, network connections, etc. 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...
virtual size_t	queueSize () const
	Return the current size of the message queue. More...
virtual bool	reopen ()
	Reopens the output destination of this Appender, e.g. More...
	StringQueueAppender (const std::string &name)
virtual	~StringQueueAppender ()
Public Member Functions inherited from LayoutAppender
	LayoutAppender (const std::string &name)
virtual bool	requiresLayout () const
	Check if the appender requires a layout. More...
virtual void	setLayout (Layout *layout=NULL)
	Set the Layout for this appender. More...
virtual	~LayoutAppender ()
Public Member Functions inherited from AppenderSkeleton
virtual void	doAppend (const LoggingEvent &event)
	Log in Appender specific way. More...
virtual Filter *	getFilter ()
	Get the Filter for this appender. More...
virtual Priority::Value	getThreshold ()
	Get the threshold priority of this Appender. More...
virtual void	setFilter (Filter *filter)
	Set a Filter for this appender. More...
virtual void	setThreshold (Priority::Value priority)
	Set the threshold priority of this Appender. More...
virtual	~AppenderSkeleton ()
	Destructor for AppenderSkeleton. More...
Public Member Functions inherited from Appender
const std::string &	getName () const
	Get the name of this appender. More...
virtual	~Appender ()
	Destructor for Appender. More...

Protected Member Functions
virtual void	_append (const LoggingEvent &event)
	Appends the LoggingEvent to the queue. More...
Protected Member Functions inherited from LayoutAppender
Layout &	_getLayout ()
	Return the layout of the appender. More...
Protected Member Functions inherited from AppenderSkeleton
	AppenderSkeleton (const std::string &name)
	Constructor for AppenderSkeleton. More...
Protected Member Functions inherited from Appender
	Appender (const std::string &name)
	Constructor for Appender. More...

Protected Attributes
std::queue< std::string >	_queue

Additional Inherited Members
Public Types inherited from LayoutAppender
typedef BasicLayout	DefaultLayoutType
Static Public Member Functions inherited from Appender
static void	closeAll ()
	Call reopen() on all existing Appenders. More...
static Appender *	getAppender (const std::string &name)
	Get a pointer to an existing Appender. More...
static bool	reopenAll ()
	Call reopen() on all existing Appenders. More...

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

StringQueueAppender()

StringQueueAppender::StringQueueAppender

(

const std::string &

name

)

~StringQueueAppender()

virtual StringQueueAppender::~StringQueueAppender ( )

virtual

Member Function Documentation

_append()

virtual void StringQueueAppender::_append ( const LoggingEvent &  event )

protectedvirtual

Appends the LoggingEvent to the queue.

Parameters

event

the LoggingEvent to layout and append to the queue.

Implements AppenderSkeleton.

close()

virtual void StringQueueAppender::close ( )

virtual

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

Implements AppenderSkeleton.

getQueue() [1/2]

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

virtual

Return the queue to which the Appends adds messages.

Returns

the message queue

getQueue() [2/2]

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

virtual

Return the queue to which the Appends adds messages.

Returns

the message queue

popMessage()

virtual std::string StringQueueAppender::popMessage ( )

virtual

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

Returns

the oldest log message

queueSize()

virtual size_t StringQueueAppender::queueSize ( ) const

virtual

Return the current size of the message queue.

Shorthand for getQueue().size().

Returns

the queue size

reopen()

virtual bool 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 AppenderSkeleton.

Member Data Documentation

_queue

std::queue<std::string> StringQueueAppender::_queue

protected

Definition at line 68 of file StringQueueAppender.hh.

---

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

• StringQueueAppender.hh