Ceylan::Log::LogListener Class Reference

LogListeners receive log messages propagated by LogTransports, and deliver them to an aggregator. More...

#include <CeylanLogListener.h>

Inheritance diagram for Ceylan::Log::LogListener:

Inheritance graph
[legend]
Collaboration diagram for Ceylan::Log::LogListener:

Collaboration graph
[legend]

List of all members.

Public Types

enum  TextOutputFormat { rawText, html }
 Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

 LogListener (LogAggregator &aggregator)
 Links this new LogListener to the specified log aggregator so that incoming log messages are sent to it.
virtual ~LogListener () throw ()
 Basic virtual destructor.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const
 Returns a user-friendly description of the state of this object.

Static Public Member Functions

static const std::string ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
 Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat GetOutputFormat ()
 Returns the current overall text format to be used by TextDisplayable instances.
static void SetOutputFormat (TextOutputFormat newOutputFormat)
 Sets the current overall text format to be used by TextDisplayable instances.

Protected Member Functions

void sendToAggregator (LogMessage &message) const
 Sends the received message to the internal aggregator.

Protected Attributes

LogAggregator_aggregator
 The aggregator this listener will send the incoming log messages to.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText
 The text format to be used currently by TextDisplayable instances.

Private Member Functions

 LogListener (const LogListener &source)
 Copy constructor made private to ensure that it will be never called.
LogListeneroperator= (const LogListener &source)
 Assignment operator made private to ensure that it will be never called.


Detailed Description

LogListeners receive log messages propagated by LogTransports, and deliver them to an aggregator.

This class acts an intermediary between a LogTransport, a channel of communication, and the log aggregator, so that transportation and log logic are uncoupled.

That way, the communication channel could be void (direct transfer of references in process memory for local log implementation) or use whichever means to send log messages, such as socket I/O in the case of distributed logs.

Note:
the inheritance from TextDisplayable is virtual since, for local log messaging, a LogListener could be a LogTransport too, whereas only one instance of the TextDisplayable mother class would be required.

Definition at line 69 of file CeylanLogListener.h.


Member Enumeration Documentation

Defines what text output formats for TextDisplayable instances are available.

Enumerator:
rawText 
html 

Definition at line 124 of file CeylanTextDisplayable.h.


Constructor & Destructor Documentation

LogListener::LogListener ( LogAggregator aggregator  )  [explicit]

Links this new LogListener to the specified log aggregator so that incoming log messages are sent to it.

Definition at line 45 of file CeylanLogListener.cc.

LogListener::~LogListener (  )  throw () [virtual]

Basic virtual destructor.

Definition at line 53 of file CeylanLogListener.cc.

Ceylan::Log::LogListener::LogListener ( const LogListener source  )  [private]

Copy constructor made private to ensure that it will be never called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.


Member Function Documentation

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat (  )  [static, inherited]

LogListener& Ceylan::Log::LogListener::operator= ( const LogListener source  )  [private]

Assignment operator made private to ensure that it will be never called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

void LogListener::sendToAggregator ( LogMessage message  )  const [protected]

Sends the received message to the internal aggregator.

Exceptions:
LogException if the operation fails.

Definition at line 78 of file CeylanLogListener.cc.

References _aggregator, and Ceylan::Log::LogAggregator::store().

Referenced by Ceylan::Log::LogTransportListenerRaw::propagate().

void TextDisplayable::SetOutputFormat ( TextOutputFormat  newOutputFormat  )  [static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:
newOutputFormat the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

const std::string TextDisplayable::ToString ( std::list< TextDisplayable * >  displayables,
Ceylan::VerbosityLevels  level = Ceylan::high 
) [static, inherited]

Returns a user-friendly description of this list of pointers to text displayable instances.

Parameters:
displayables a list of pointers to TextDisplayable instances/
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
toString, Ceylan::VerbosityLevels

Definition at line 45 of file CeylanTextDisplayable.cc.

References Ceylan::formatStringList().

const string LogListener::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const [virtual]

Returns a user-friendly description of the state of this object.

Parameters:
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
TextDisplayable

Implements Ceylan::TextDisplayable.

Reimplemented in Ceylan::Log::LogTransportListenerRaw.

Definition at line 60 of file CeylanLogListener.cc.

References _aggregator, Ceylan::high, Ceylan::low, and Ceylan::Log::LogAggregator::toString().

Referenced by Ceylan::Log::LogPlug::ToString().


Member Data Documentation

The aggregator this listener will send the incoming log messages to.

Definition at line 122 of file CeylanLogListener.h.

Referenced by sendToAggregator(), and toString().

TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited]

The text format to be used currently by TextDisplayable instances.

Note:
Defaults to raw text.

Definition at line 158 of file CeylanTextDisplayable.h.

Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().


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

Generated on Thu Jun 4 20:40:26 2009 for Ceylan by  doxygen 1.5.8