CBufferedLogOutputter Class Reference

Save log history. More...

#include <LogOutputters.h>

Inherits ILogOutputter.

Collaboration diagram for CBufferedLogOutputter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef CBuffer::const_iterator const_iterator

Public Member Functions

 CBufferedLogOutputter (UInt32 maxBufferSize)
virtual void open (const char *title)
 Open the outputter.
virtual void close ()
 Close the outputter.
virtual void show (bool showIfEmpty)
 Show the outputter.
virtual bool write (ELevel level, const char *message)
 Write a message with level.
virtual const char * getNewline () const
 Returns the newline sequence for the outputter.
accessors



const_iterator begin () const
 Get start of buffer.
const_iterator end () const
 Get end of buffer.

Detailed Description

Save log history.

This outputter records the last N log messages.

Definition at line 118 of file LogOutputters.h.


Member Function Documentation

void CBufferedLogOutputter::close (  )  [virtual]

Close the outputter.

Close the outputter. Calling this method on an already closed outputter must have no effect.

Implements ILogOutputter.

Definition at line 241 of file LogOutputters.cpp.

const char * CBufferedLogOutputter::getNewline (  )  const [virtual]

Returns the newline sequence for the outputter.

Different outputters use different character sequences for newlines. This method returns the appropriate newline sequence for this outputter.

Implements ILogOutputter.

Definition at line 264 of file LogOutputters.cpp.

void CBufferedLogOutputter::open ( const char *  title  )  [virtual]

Open the outputter.

Opens the outputter for writing. Calling this method on an already open outputter must have no effect.

Implements ILogOutputter.

Definition at line 235 of file LogOutputters.cpp.

void CBufferedLogOutputter::show ( bool  showIfEmpty  )  [virtual]

Show the outputter.

Causes the output to become visible. This generally only makes sense for a logger in a graphical user interface. Other implementations will do nothing. Iff showIfEmpty is false then the implementation may optionally only show the log if it's not empty.

Implements ILogOutputter.

Definition at line 248 of file LogOutputters.cpp.

bool CBufferedLogOutputter::write ( ELevel  level,
const char *  message 
) [virtual]

Write a message with level.

Writes message, which has the given level, to a log. If this method returns true then CLog will stop passing the message to all outputters in the outputter chain, otherwise it continues. Most implementations should return true.

Implements ILogOutputter.

Definition at line 254 of file LogOutputters.cpp.


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

Generated on 12 Nov 2010 for synergy-plus by  doxygen 1.6.1