log4cpp::StringQueueAppender Class Reference

#include <StringQueueAppender.hh>

Inheritance diagram for log4cpp::StringQueueAppender:

[legend]

List of all members.

Public Member Functions
virtual void	close ()
virtual void	close ()
virtual const std::queue < std::string > &	getQueue () const
virtual std::queue< std::string > &	getQueue ()
virtual const std::queue < std::string > &	getQueue () const
virtual std::queue< std::string > &	getQueue ()
virtual std::string	popMessage ()
virtual std::string	popMessage ()
virtual size_t	queueSize () const
virtual size_t	queueSize () const
virtual bool	reopen ()
virtual bool	reopen ()
	StringQueueAppender (const std::string &name)
	StringQueueAppender (const std::string &name)
virtual	~StringQueueAppender ()
virtual	~StringQueueAppender ()
Protected Member Functions
virtual void	_append (const LoggingEvent &event)
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 include/log4cpp/StringQueueAppender.hh.

---

Constructor & Destructor Documentation

log4cpp::StringQueueAppender::StringQueueAppender

(

const std::string &

name

)

Definition at line 14 of file StringQueueAppender.cpp.

log4cpp::StringQueueAppender::~StringQueueAppender

(

)

[virtual]

Definition at line 18 of file StringQueueAppender.cpp.

log4cpp::StringQueueAppender::StringQueueAppender

(

const std::string &

name

)

virtual log4cpp::StringQueueAppender::~StringQueueAppender

(

)

[virtual]

---

Member Function Documentation

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

Implements log4cpp::AppenderSkeleton.

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.

Implements log4cpp::AppenderSkeleton.

Definition at line 26 of file StringQueueAppender.cpp.

virtual void log4cpp::StringQueueAppender::close

(

)

[virtual]

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

Implements log4cpp::AppenderSkeleton.

void log4cpp::StringQueueAppender::close

(

)

[virtual]

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

Implements log4cpp::AppenderSkeleton.

Definition at line 22 of file StringQueueAppender.cpp.

virtual const std::queue<std::string>& log4cpp::StringQueueAppender::getQueue

(

)

const [virtual]

Return the queue to which the Appends adds messages.

Returns:

the message queue

virtual std::queue<std::string>& log4cpp::StringQueueAppender::getQueue

(

)

[virtual]

Return the queue to which the Appends adds messages.

Returns:

the message queue

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 38 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 34 of file StringQueueAppender.cpp.

virtual std::string log4cpp::StringQueueAppender::popMessage

(

)

[virtual]

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

Returns:

the oldest log message

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 46 of file StringQueueAppender.cpp.

virtual size_t log4cpp::StringQueueAppender::queueSize

(

)

const [virtual]

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

Returns:

the queue size

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 42 of file StringQueueAppender.cpp.

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.

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.

Definition at line 30 of file StringQueueAppender.cpp.

---

Member Data Documentation

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

Definition at line 68 of file include/log4cpp/StringQueueAppender.hh.

---

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

• include/log4cpp/StringQueueAppender.hh
• install/include/log4cpp/StringQueueAppender.hh
• StringQueueAppender.cpp