log4cpp:StringQueueAppender (3)

NAME

       log4cpp::StringQueueAppender - This class puts log messages in an in-
       memory queue.

SYNOPSIS

       #include <StringQueueAppender.hh>

       Inherits log4cpp::LayoutAppender.

   Public Methods
       StringQueueAppender (const std::string &name)
       virtual ~StringQueueAppender ()
       virtual bool reopen ()
           Reopens the output destination of this Appender, e.g.
       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.
       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.

   Protected Methods
       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

CONSTRUCTOR & DESTRUCTOR DOCUMENTATION

   log4cpp::StringQueueAppender::StringQueueAppender (const std::string &
       name)
   log4cpp::StringQueueAppender::~StringQueueAppender () [virtual]

MEMBER FUNCTION DOCUMENTATION

   void log4cpp::StringQueueAppender::_append (const LoggingEvent & event)
       [protected, virtual]
       Appends the LoggingEvent to the queue.

       Parameters:


   const std::queue< std::string > & log4cpp::StringQueueAppender::getQueue ()
       [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 () [virtual]
       Return the current size of the message queue.

       Shorthand for getQueue().size().

       Returns:
           the queue size

   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]

AUTHOR

       Generated automatically by Doxygen for log4cpp from the source code.

log4cpp                           19 Aug 2003  log4cpp::StringQueueAppender(3)