Ceylan::Log::LogTransport Class Reference

This abstract class has for mission to take a Log message from a LogSource and to bring it to the relevant LogListener. More...

#include <CeylanLogTransport.h>

Inheritance diagram for Ceylan::Log::LogTransport:

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

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

 LogTransport ()
 Constructs a blank LogTransport.
virtual ~LogTransport () throw ()
 Basic virtual destructor.
virtual void propagate (LogMessage &message)=0
 Propagates message to the relevant LogListener.
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.

Static Protected Attributes

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

Private Member Functions

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


Detailed Description

This abstract class has for mission to take a Log message from a LogSource and to bring it to the relevant LogListener.

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

the transport takes ownership of log message objects, it has therefore to make sure that they are eventually deallocated.

See also:
LogSource, LogListener

Definition at line 61 of file CeylanLogTransport.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

LogTransport::LogTransport (  ) 

Constructs a blank LogTransport.

See also:
setTransport

Definition at line 37 of file CeylanLogTransport.cc.

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

Basic virtual destructor.

Definition at line 45 of file CeylanLogTransport.cc.

Ceylan::Log::LogTransport::LogTransport ( const LogTransport 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]

LogTransport& Ceylan::Log::LogTransport::operator= ( const LogTransport 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.

virtual void Ceylan::Log::LogTransport::propagate ( LogMessage message  )  [pure virtual]

Propagates message to the relevant LogListener.

Parameters:
message the message which is to be propagated
Exceptions:
LogException should the operation fail.
Note:
Most implementations, more elaborate that local raw log transfers, should end up deallocating the specified message.

Implemented in Ceylan::Log::LogTransportListenerRaw.

Referenced by Ceylan::Log::LogSource::directSend().

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 LogTransport::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 52 of file CeylanLogTransport.cc.

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


Member Data Documentation

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:30 2009 for Ceylan by  doxygen 1.5.8