This class puts log messages in an in-memory queue. More...
#include <StringQueueAppender.hh>
Public Member Functions | |
| virtual void | close () |
| Release any resources allocated within the appender such as file handles, network connections, etc. | |
| virtual std::queue< std::string > & | getQueue () |
| Return the queue to which the Appends adds messages. | |
| virtual const std::queue < std::string > & | getQueue () const |
| Return the queue to which the Appends adds messages. | |
| virtual std::string | popMessage () |
| Pop the oldest log message from the front of the queue. | |
| virtual size_t | queueSize () const |
| Return the current size of the message queue. | |
| virtual bool | reopen () |
| Reopens the output destination of this Appender, e.g. | |
| StringQueueAppender (const std::string &name) | |
| virtual | ~StringQueueAppender () |
Protected Member Functions | |
| virtual void | _append (const LoggingEvent &event) |
| Appends the LoggingEvent to the queue. | |
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
| StringQueueAppender::StringQueueAppender | ( | const std::string & | name | ) |
| virtual StringQueueAppender::~StringQueueAppender | ( | ) | [virtual] |
Member Function Documentation
| virtual void 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 AppenderSkeleton.
| virtual void StringQueueAppender::close | ( | ) | [virtual] |
Release any resources allocated within the appender such as file handles, network connections, etc.
Implements AppenderSkeleton.
| virtual std::queue<std::string>& StringQueueAppender::getQueue | ( | ) | [virtual] |
Return the queue to which the Appends adds messages.
- Returns:
- the message queue
| virtual const std::queue<std::string>& StringQueueAppender::getQueue | ( | ) | const [virtual] |
Return the queue to which the Appends adds messages.
- Returns:
- the message queue
| virtual std::string StringQueueAppender::popMessage | ( | ) | [virtual] |
Pop the oldest log message from the front of the queue.
- Returns:
- the oldest log message
| virtual size_t StringQueueAppender::queueSize | ( | ) | const [virtual] |
Return the current size of the message queue.
Shorthand for getQueue().size().
- Returns:
- the queue size
| 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
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: