This class gathers the two endpoints of Log propagation: the LogTransport (the beginning) and the LogListener (the end). More...
#include <CeylanLogTransportListenerRaw.h>
Public Types | |
enum | TextOutputFormat { rawText, html } |
Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
LogTransportListenerRaw (LogAggregator &aggregator) | |
Links this new LogListener to the specified log aggregator so that incoming log messages are sent to it. | |
virtual | ~LogTransportListenerRaw () throw () |
Basic virtual destructor. | |
virtual void | propagate (LogMessage &message) |
Propagates message to the relevant aggregator. | |
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 | |
LogTransportListenerRaw (const LogTransportListenerRaw &source) | |
Copy constructor made private to ensure that it will be never called. | |
LogTransportListenerRaw & | operator= (const LogTransportListenerRaw &source) |
Assignment operator made private to ensure that it will be never called. |
This class gathers the two endpoints of Log propagation: the LogTransport (the beginning) and the LogListener (the end).
This particular implementation of the log system corresponds to the special case where log sources and their target (the aggregator) are both local, i.e. hosted by the same process. Obviously, their is no need to do anything for log messages to be propagated, so the only thing the instances of this class do is comply with the framework and simply takes a log message reference from a log source and gives it to the aggregator: this is the most basic communication bus.
Definition at line 65 of file CeylanLogTransportListenerRaw.h.
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
LogTransportListenerRaw::LogTransportListenerRaw | ( | LogAggregator & | aggregator | ) | [explicit] |
Links this new LogListener to the specified log aggregator so that incoming log messages are sent to it.
Definition at line 41 of file CeylanLogTransportListenerRaw.cc.
LogTransportListenerRaw::~LogTransportListenerRaw | ( | ) | throw () [virtual] |
Basic virtual destructor.
Definition at line 51 of file CeylanLogTransportListenerRaw.cc.
Ceylan::Log::LogTransportListenerRaw::LogTransportListenerRaw | ( | const LogTransportListenerRaw & | 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().
LogTransportListenerRaw& Ceylan::Log::LogTransportListenerRaw::operator= | ( | const LogTransportListenerRaw & | 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 LogTransportListenerRaw::propagate | ( | LogMessage & | message | ) | [virtual] |
Propagates message to the relevant aggregator.
message | the message which is to be propagated |
LogException | if the operation fails. |
Implements Ceylan::Log::LogTransport.
Definition at line 58 of file CeylanLogTransportListenerRaw.cc.
References Ceylan::Log::LogListener::sendToAggregator().
void LogListener::sendToAggregator | ( | LogMessage & | message | ) | const [protected, inherited] |
Sends the received message to the internal aggregator.
LogException | if the operation fails. |
Definition at line 78 of file CeylanLogListener.cc.
References Ceylan::Log::LogListener::_aggregator, and Ceylan::Log::LogAggregator::store().
Referenced by 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 LogTransportListenerRaw::toString | ( | Ceylan::VerbosityLevels | level = Ceylan::high |
) | const [virtual] |
Returns a user-friendly description of the state of this object.
level | the requested verbosity level. |
Reimplemented from Ceylan::Log::LogListener.
Definition at line 68 of file CeylanLogTransportListenerRaw.cc.
LogAggregator* Ceylan::Log::LogListener::_aggregator [protected, inherited] |
The aggregator this listener will send the incoming log messages to.
Definition at line 122 of file CeylanLogListener.h.
Referenced by Ceylan::Log::LogListener::sendToAggregator(), and Ceylan::Log::LogListener::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().