#include <CeylanLogListener.h>
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. | |
LogListener & | operator= (const LogListener &source) |
Assignment operator made private to ensure that it will be never called. |
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.
Definition at line 69 of file CeylanLogListener.h.
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
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] |
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.
TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat | ( | ) | [static, inherited] |
Returns the current overall text format to be used by TextDisplayable instances.
Definition at line 63 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().
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.
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.
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.
displayables | a list of pointers to TextDisplayable instances/ | |
level | the requested verbosity level. |
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.
level | the requested verbosity level. |
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().
LogAggregator* Ceylan::Log::LogListener::_aggregator [protected] |
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.
Definition at line 158 of file CeylanTextDisplayable.h.
Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().