Ceylan::Log::LogAggregatorRaw Class Reference

This class implements the LogAggregator interface thanks to text files encoded with raw formatting. More...

#include <CeylanLogAggregatorRaw.h>

Inheritance diagram for Ceylan::Log::LogAggregatorRaw:

Collaboration diagram for Ceylan::Log::LogAggregatorRaw:

List of all members.

Public Types

enum TextOutputFormat { rawText, html }

Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

LogAggregatorRaw (const std::string &logFilename, bool immediateWrite=true, bool useGlobalLevelOfDetail=true, bool beSmart=true)

Constructs a LogAggregatorRaw which will output incoming log messages in file specified by logFilename.

virtual ~LogAggregatorRaw () throw ()

Virtual destructor.

virtual void aggregate ()

Aggregates all channel and log messages informations in the aggregator file.

virtual void store (LogMessage &message)

Classifies and stores message internally, according to the corresponding channels they contain.

virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const

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

virtual LogChannel & createBasicChannel (const std::string &channelName)

Creates, if possible, a new basic channel whose name is channelName.

virtual ObjectChannel & createObjectChannel (LogMessage &message)

Creates, if possible, a new object channel corresponding to the specified Loggable message.

virtual bool hasChannel (const std::string &channelName) const

Tells whether this aggregator has already a channel named channelName.

virtual LogChannel * findChannel (const std::string &channelName) const

Finds, if any, a channel in LogAggregator's list of channels whose name is channelName.

virtual void transferChannel (LogChannel &source, LogChannel &target)

Transfers all the messages of source into target, updates their channel identifier so that it matches the one of target.

virtual void removeChannel (LogChannel &target)

Removes completly a log channel.

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 Public Attributes

static const LevelOfDetail DefaultGlobalLevelOfDetail = Ceylan::Log::DefaultLevelOfDetailForListener

Default value for the aggregator-wide level of detail.

Protected Member Functions

virtual void write (const LogChannel &channel) const

Internal method used to perform the effective writing of log channels into file.

virtual void write (const LogMessage &message) const

Internal method used to perform the effective writing of log messages into file.

virtual LogChannel * findBasicChannel (const std::string &basicChannelName) const

Finds, if any, a Log channel in LogAggregator's list of channels whose name is channelName.

virtual ObjectChannel * findObjectChannel (const std::string &nonPrefixedChannelName) const

Finds, if any, an Object channel in LogAggregator's list of object channels whose short name is channelName (no protocol prefix or separator allowed).

virtual void createBasicChannelFrom (LogMessage &message)

Creates a basic (non protocol-prefixed) channel from specified message, which is automatically added to this new channel.

virtual void createLoggableChannelFrom (LogMessage &message)

Creates a Loggable channel from specified message.

virtual void storeBasicMessage (LogMessage &basicLogMessage)

Classify and stores basic log message basicLogMessage internally, according to the corresponding channel it contains.

virtual void storeObjectMessage (LogMessage &objectLogMessage)

Classify and stores object log message objectLogMessage internally, according to the corresponding channel it contains.

virtual void demangle (LogMessage &objectLogMessage)

Corrects, if possible, any mangled class name in specified message.

virtual Ceylan::VerbosityLevels getOverallVerbosityLevel () const

Returns the most appropriate level of detail for log channel output, depending only on the state of the aggregator.

virtual Ceylan::VerbosityLevels getMessageVerbosityLevel (const LogMessage &message) const

Returns the most appropriate level of detail for log message output, depending on the state of the aggregator and on the message's level of detail.

Static Protected Member Functions

static Ceylan::VerbosityLevels ConvertListenerLevelOfDetailToVerbosityLevel (LevelOfDetail level)

Converts a level of detail of a log listener into a corresponding verbosity level.

static Ceylan::VerbosityLevels ConvertMessageLevelOfDetailToVerbosityLevel (LevelOfDetail level)

Converts a level of detail of a log message into a corresponding verbosity level.

Protected Attributes

std::string _logFilename

The file name where log message aggregation should take place.

System::File * _outputFile

The file where aggregations will take place.

bool _immediateWrite

Tells whether log messages should be written to log file as soon as they are received.

std::list< LogChannel * > _channelList

List of all known Log channels.

bool _beSmart

Tells whether this aggregator should cope with mangled class names.

bool _useGlobalLevelOfDetail

Tells whether a global (aggregator-wide) level of detail for channels should be used.

LevelOfDetail _globalLevelOfDetail

Defines the aggregator-wide level of detail, used if _useGlobalLevelOfDetail is set.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText

The text format to be used currently by TextDisplayable instances.

Private Member Functions

LogAggregatorRaw (const LogAggregatorRaw &source)

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

LogAggregatorRaw & operator= (const LogAggregatorRaw &source)

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

Detailed Description

This class implements the LogAggregator interface thanks to text files encoded with raw formatting.

Note:: This is the simpliest file-based log aggregator, for example for users that cannot access to an HTML browser, or for non-terminating programs (example : when being debugged), which therefore need on-the-fly log writing.

Log messages are stored in chronological order (based on the time they were received, not on their respective timestamp), all in a row, each prefixed by its channel name.

See also:: LogAggregator

Definition at line 74 of file CeylanLogAggregatorRaw.h.

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

Constructor & Destructor Documentation

LogAggregatorRaw::LogAggregatorRaw	(	const std::string &	logFilename,
		bool	immediateWrite = `true`,
		bool	useGlobalLevelOfDetail = `true`,
		bool	beSmart = `true`
	)			`[explicit]`

Constructs a LogAggregatorRaw which will output incoming log messages in file specified by logFilename.

The logs are stored with a raw encoding, as opposed to HTML encoding for example.

Parameters:

	logFilename	the file where logs should be stored.
	immediateWrite	tells whether the aggregator should write log messages as soon as they are received (the safe and default behaviour).
	useGlobalLevelOfDetail	tells whether log channels levels of detail are to be overriden by the aggregator-wide one.
	beSmart	tells whether this aggregator should be smart and auto-correct messages with faulty classnames.

Exceptions:

LogAggregatorException

if the operation failed.

Definition at line 51 of file CeylanLogAggregatorRaw.cc.

References _immediateWrite, _outputFile, CEYLAN_LOG, Ceylan::System::File::Create(), dataUtils::e, and Ceylan::Exception::toString().

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

Virtual destructor.

Note:: If this aggregator has been set to be smart, it will automatically trigger log aggregation upon deletion.

Definition at line 94 of file CeylanLogAggregatorRaw.cc.

References Ceylan::Log::LogAggregator::_beSmart, _outputFile, aggregate(), CEYLAN_LOG, dataUtils::e, and Ceylan::Exception::toString().

Ceylan::Log::LogAggregatorRaw::LogAggregatorRaw ( const LogAggregatorRaw & 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

void LogAggregatorRaw::aggregate ( ) [virtual]

Aggregates all channel and log messages informations in the aggregator file.

Exceptions:

LogAggregatorException

if the operation failed.

Note:: this method does nothing if the immediate write flag is turned on : work should be already done.

Implements Ceylan::Log::LogAggregator.

Definition at line 129 of file CeylanLogAggregatorRaw.cc.

References Ceylan::Log::LogAggregator::_channelList, _immediateWrite, _logFilename, _outputFile, CEYLAN_LOG, Ceylan::Timestamp::toString(), write(), and Ceylan::System::File::write().

Referenced by ~LogAggregatorRaw().

Ceylan::VerbosityLevels LogAggregator::ConvertListenerLevelOfDetailToVerbosityLevel ( LevelOfDetail level ) [static, protected, inherited]

Converts a level of detail of a log listener into a corresponding verbosity level.

Definition at line 824 of file CeylanLogAggregator.cc.

References Ceylan::Log::DefaultLevelOfDetailForListener, Ceylan::high, Ceylan::low, Ceylan::Log::MaximumLevelOfDetailForListener, and Ceylan::medium.

Referenced by Ceylan::Log::LogAggregator::getOverallVerbosityLevel().

Ceylan::VerbosityLevels LogAggregator::ConvertMessageLevelOfDetailToVerbosityLevel ( LevelOfDetail level ) [static, protected, inherited]

Converts a level of detail of a log message into a corresponding verbosity level.

Definition at line 856 of file CeylanLogAggregator.cc.

References Ceylan::Log::DefaultLevelOfDetailForMessage, Ceylan::high, Ceylan::low, Ceylan::Log::MaximumLevelOfDetailForMessage, and Ceylan::medium.

Referenced by Ceylan::Log::LogAggregator::getMessageVerbosityLevel().

LogChannel & LogAggregator::createBasicChannel ( const std::string & channelName ) [virtual, inherited]

Creates, if possible, a new basic channel whose name is channelName.

Definition at line 120 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_channelList, CEYLAN_LOG, and Ceylan::Log::LogAggregator::hasChannel().

Referenced by Ceylan::Log::LogAggregator::createBasicChannelFrom().

void LogAggregator::createBasicChannelFrom ( LogMessage & message ) [protected, virtual, inherited]

Creates a basic (non protocol-prefixed) channel from specified message, which is automatically added to this new channel.

Definition at line 397 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogChannel::addMessage(), Ceylan::Log::LogAggregator::createBasicChannel(), and Ceylan::Log::LogMessage::getChannelName().

Referenced by Ceylan::Log::LogAggregator::createLoggableChannelFrom(), and Ceylan::Log::LogAggregator::storeBasicMessage().

void LogAggregator::createLoggableChannelFrom ( LogMessage & message ) [protected, virtual, inherited]

Creates a Loggable channel from specified message.

Parameters:

message

the incoming Loggable message which triggers this channel creation.

Note:: If the incoming message that would lead to create a channel A has the same address as past events which led to the creation of a channel B, then all the messages in B will be transferred into a newly created channel A, no matter A and B. If messages are sent from destructors, then the channel will be finally renamed as the base class, and not the specialized class being effectively used. So sending messages from destructors should be avoided.

Definition at line 413 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_beSmart, Ceylan::Log::LogAggregator::_channelList, Ceylan::Log::ObjectChannel::addMessage(), CEYLAN_LOG, Ceylan::Log::LogAggregator::createBasicChannelFrom(), Ceylan::Log::LogAggregator::createObjectChannel(), Ceylan::Log::ObjectIdentifier::differentButMatches(), Ceylan::Log::ObjectIdentifier::generateFromChannelName(), Ceylan::Log::LogMessage::getChannelName(), Ceylan::Log::Loggable::GetEmbeddedChannelName(), Ceylan::Exception::toString(), and Ceylan::Log::LogAggregator::transferChannel().

Referenced by Ceylan::Log::LogAggregator::storeObjectMessage().

ObjectChannel & LogAggregator::createObjectChannel ( LogMessage & message ) [virtual, inherited]

Creates, if possible, a new object channel corresponding to the specified Loggable message.

Definition at line 142 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_channelList, CEYLAN_LOG, Ceylan::Log::LogMessage::getChannelName(), Ceylan::Log::Loggable::GetEmbeddedChannelName(), and Ceylan::Log::LogAggregator::hasChannel().

Referenced by Ceylan::Log::LogAggregator::createLoggableChannelFrom().

void LogAggregator::demangle ( LogMessage & objectLogMessage ) [protected, virtual, inherited]

Corrects, if possible, any mangled class name in specified message.

Definition at line 692 of file CeylanLogAggregator.cc.

References Ceylan::demangleSymbol(), Ceylan::Log::LogMessage::getChannelName(), Ceylan::Log::ObjectIdentifier::Separator, and Ceylan::Log::LogMessage::setChannelName().

Referenced by Ceylan::Log::LogAggregator::storeObjectMessage().

LogChannel * LogAggregator::findBasicChannel ( const std::string & basicChannelName ) const [protected, virtual, inherited]

Finds, if any, a Log channel in LogAggregator's list of channels whose name is channelName.

Returns:: the basic channel, if found, otherwise a null pointer.

Note:: this method is dedicated to find basic log channels, not object ones.

Definition at line 302 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_channelList, and CEYLAN_LOG.

Referenced by Ceylan::Log::LogAggregator::findChannel(), and Ceylan::Log::LogAggregator::storeBasicMessage().

LogChannel * LogAggregator::findChannel ( const std::string & channelName ) const [virtual, inherited]

Finds, if any, a channel in LogAggregator's list of channels whose name is channelName.

Returns:: the channel, if found, otherwise a null pointer.

Note:: if the specified channel name is an object channel name (typically starting by 'loggable://'), search will be only performed on object channels.

Definition at line 181 of file CeylanLogAggregator.cc.

References CEYLAN_LOG, Ceylan::Log::LogAggregator::findBasicChannel(), Ceylan::Log::LogAggregator::findObjectChannel(), Ceylan::Log::Loggable::GetEmbeddedChannelName(), and Ceylan::Log::Loggable::IsALoggableChannelName().

Referenced by Ceylan::Log::LogAggregator::hasChannel().

ObjectChannel * LogAggregator::findObjectChannel ( const std::string & nonPrefixedChannelName ) const [protected, virtual, inherited]

Finds, if any, an Object channel in LogAggregator's list of object channels whose short name is channelName (no protocol prefix or separator allowed).

Returns:: the object channel, if found, otherwise a null pointer.

Note:: this method is dedicated to find object log channels, not basic ones.

Definition at line 349 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_channelList, CEYLAN_LOG, and Ceylan::Log::LogChannel::getName().

Referenced by Ceylan::Log::LogAggregator::findChannel(), and Ceylan::Log::LogAggregator::storeObjectMessage().

Ceylan::VerbosityLevels LogAggregator::getMessageVerbosityLevel ( const LogMessage & message ) const [protected, virtual, inherited]

Returns the most appropriate level of detail for log message output, depending on the state of the aggregator and on the message's level of detail.

Basically, maps a global or local level of detail to a verbosity level.

Definition at line 790 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_globalLevelOfDetail, Ceylan::Log::LogAggregator::_useGlobalLevelOfDetail, CEYLAN_LOG, Ceylan::Log::LogAggregator::ConvertMessageLevelOfDetailToVerbosityLevel(), Ceylan::Log::LogMessage::getLevelOfDetail(), and Ceylan::toString().

Referenced by write(), and Ceylan::Log::LogAggregatorConsole::write().

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().

Ceylan::VerbosityLevels LogAggregator::getOverallVerbosityLevel ( ) const [protected, virtual, inherited]

Returns the most appropriate level of detail for log channel output, depending only on the state of the aggregator.

Basically, maps a global or local level of detail to a verbosity level.

Definition at line 760 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_globalLevelOfDetail, Ceylan::Log::LogAggregator::_useGlobalLevelOfDetail, CEYLAN_LOG, Ceylan::Log::LogAggregator::ConvertListenerLevelOfDetailToVerbosityLevel(), Ceylan::Log::DefaultLevelOfDetailForListener, and Ceylan::toString().

Referenced by write(), and Ceylan::Log::LogAggregatorConsole::write().

bool LogAggregator::hasChannel ( const std::string & channelName ) const [virtual, inherited]

Tells whether this aggregator has already a channel named channelName.

Exceptions:

LogException

if an inconsistency is detected in channel list.

Definition at line 171 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::findChannel().

Referenced by Ceylan::Log::LogAggregator::createBasicChannel(), and Ceylan::Log::LogAggregator::createObjectChannel().

LogAggregatorRaw& Ceylan::Log::LogAggregatorRaw::operator= ( const LogAggregatorRaw & 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 LogAggregator::removeChannel ( LogChannel & target ) [virtual, inherited]

Removes completly a log channel.

Definition at line 267 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogAggregator::_channelList, CEYLAN_LOG, and Ceylan::Log::LogChannel::getName().

Referenced by Ceylan::Log::LogAggregator::transferChannel().

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().

void LogAggregatorRaw::store ( LogMessage & message ) [virtual]

Classifies and stores message internally, according to the corresponding channels they contain.

Note:: this implementation, if immediateWrite mode was selected, will immediatly write this message to log file.

Parameters:

message

the log message to be stored, the aggregator takes ownership of it.

Exceptions:

LogException

if the operation failed.

Reimplemented from Ceylan::Log::LogAggregator.

Definition at line 161 of file CeylanLogAggregatorRaw.cc.

References _immediateWrite, CEYLAN_LOG, Ceylan::Log::LogMessage::toString(), and write().

void LogAggregator::storeBasicMessage ( LogMessage & basicLogMessage ) [protected, virtual, inherited]

Classify and stores basic log message basicLogMessage internally, according to the corresponding channel it contains.

Parameters:

message

the basic log message to be stored, the aggregator takes ownership of it.

Definition at line 597 of file CeylanLogAggregator.cc.

References CEYLAN_LOG, Ceylan::Log::LogAggregator::createBasicChannelFrom(), Ceylan::Log::LogAggregator::findBasicChannel(), and Ceylan::Log::LogMessage::getChannelName().

Referenced by Ceylan::Log::LogAggregator::store().

void LogAggregator::storeObjectMessage ( LogMessage & objectLogMessage ) [protected, virtual, inherited]

Classify and stores object log message objectLogMessage internally, according to the corresponding channel it contains.

Parameters:

objectLogMessage

the object log message to be stored, the aggregator takes ownership of it.

Definition at line 628 of file CeylanLogAggregator.cc.

References Ceylan::Log::ObjectChannel::addMessage(), CEYLAN_LOG, Ceylan::Log::LogAggregator::createLoggableChannelFrom(), Ceylan::Log::LogAggregator::demangle(), Ceylan::Log::LogAggregator::findObjectChannel(), Ceylan::Log::LogMessage::getChannelName(), Ceylan::Log::Loggable::GetEmbeddedChannelName(), and Ceylan::Log::LogMessage::setChannelName().

Referenced by Ceylan::Log::LogAggregator::store().

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 LogAggregatorRaw::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

Reimplemented from Ceylan::Log::LogAggregator.

Definition at line 234 of file CeylanLogAggregatorRaw.cc.

References _immediateWrite, and Ceylan::Log::LogAggregator::_useGlobalLevelOfDetail.

void LogAggregator::transferChannel	(	LogChannel &	source,
		LogChannel &	target
	)			`[virtual, inherited]`

Transfers all the messages of source into target, updates their channel identifier so that it matches the one of target.

This method helps correcting wrong channel names due to mangled class names.

Note:: As the ownership of transferred message is transferred to the target channel, the source message pointers are set to null so that, when source channel will be deallocated, messages will not be touched.

Definition at line 204 of file CeylanLogAggregator.cc.

References Ceylan::Log::LogChannel::_messages, Ceylan::Log::LogChannel::addMessage(), CEYLAN_LOG, Ceylan::Log::LogChannel::getName(), Ceylan::low, Ceylan::Log::LogAggregator::removeChannel(), Ceylan::Log::LogMessage::setChannelName(), Ceylan::Log::LogMessage::toString(), and Ceylan::Log::LogChannel::toString().

Referenced by Ceylan::Log::LogAggregator::createLoggableChannelFrom().

void LogAggregatorRaw::write ( const LogMessage & message ) const [protected, virtual]

Internal method used to perform the effective writing of log messages into file.

Parameters:

message

the log message to write

Note:: this method is mainly used when immediate writing mode is set.

Exceptions:

LogException

if the write operation failed.

Definition at line 209 of file CeylanLogAggregatorRaw.cc.

References _outputFile, CEYLAN_LOG, dataUtils::e, Ceylan::Log::LogAggregator::getMessageVerbosityLevel(), Ceylan::Exception::toString(), Ceylan::Log::LogMessage::toString(), and Ceylan::System::File::write().

void LogAggregatorRaw::write ( const LogChannel & channel ) const [protected, virtual]

Internal method used to perform the effective writing of log channels into file.

Parameters:

channel

the log channel to save into file.

Exceptions:

LogException

if the write operation failed.

Definition at line 185 of file CeylanLogAggregatorRaw.cc.

References _outputFile, CEYLAN_LOG, dataUtils::e, Ceylan::Log::LogAggregator::getOverallVerbosityLevel(), Ceylan::Exception::toString(), Ceylan::Log::LogChannel::toString(), and Ceylan::System::File::write().

Referenced by aggregate(), and store().

Member Data Documentation

bool Ceylan::Log::LogAggregator::_beSmart [protected, inherited]

Tells whether this aggregator should cope with mangled class names.

Definition at line 417 of file CeylanLogAggregator.h.

Referenced by Ceylan::Log::LogAggregator::createLoggableChannelFrom(), Ceylan::Log::LogAggregator::toString(), Ceylan::Log::LogAggregatorConsole::~LogAggregatorConsole(), Ceylan::Log::LogAggregatorHTML::~LogAggregatorHTML(), and ~LogAggregatorRaw().

std::list<LogChannel *> Ceylan::Log::LogAggregator::_channelList [protected, inherited]

List of all known Log channels.

Definition at line 407 of file CeylanLogAggregator.h.

LevelOfDetail Ceylan::Log::LogAggregator::_globalLevelOfDetail [protected, inherited]

Defines the aggregator-wide level of detail, used if _useGlobalLevelOfDetail is set.

Reimplemented in Ceylan::Log::LogAggregatorConsole, and Ceylan::Log::LogAggregatorHTML.

Definition at line 435 of file CeylanLogAggregator.h.

Referenced by Ceylan::Log::LogAggregator::getMessageVerbosityLevel(), and Ceylan::Log::LogAggregator::getOverallVerbosityLevel().

bool Ceylan::Log::LogAggregatorRaw::_immediateWrite [protected]

Tells whether log messages should be written to log file as soon as they are received.

Definition at line 229 of file CeylanLogAggregatorRaw.h.

Referenced by aggregate(), LogAggregatorRaw(), store(), and toString().

std::string Ceylan::Log::LogAggregatorRaw::_logFilename [protected]

The file name where log message aggregation should take place.

Definition at line 215 of file CeylanLogAggregatorRaw.h.

Referenced by aggregate().

System::File* Ceylan::Log::LogAggregatorRaw::_outputFile [protected]

The file where aggregations will take place.

Definition at line 220 of file CeylanLogAggregatorRaw.h.

Referenced by aggregate(), LogAggregatorRaw(), write(), and ~LogAggregatorRaw().

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().

bool Ceylan::Log::LogAggregator::_useGlobalLevelOfDetail [protected, inherited]

Tells whether a global (aggregator-wide) level of detail for channels should be used.

Note:: if set, will override log channels levels of details.

Reimplemented in Ceylan::Log::LogAggregatorConsole, and Ceylan::Log::LogAggregatorHTML.

Definition at line 427 of file CeylanLogAggregator.h.

Referenced by Ceylan::Log::LogAggregator::getMessageVerbosityLevel(), Ceylan::Log::LogAggregator::getOverallVerbosityLevel(), and toString().

const LevelOfDetail LogAggregator::DefaultGlobalLevelOfDetail = Ceylan::Log::DefaultLevelOfDetailForListener [static, inherited]

Default value for the aggregator-wide level of detail.

Reimplemented in Ceylan::Log::LogAggregatorHTML.

Definition at line 247 of file CeylanLogAggregator.h.

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


Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	LogAggregatorRaw (const std::string &logFilename, bool immediateWrite=true, bool useGlobalLevelOfDetail=true, bool beSmart=true)
	Constructs a LogAggregatorRaw which will output incoming log messages in file specified by logFilename.
virtual	~LogAggregatorRaw () throw ()
	Virtual destructor.
virtual void	aggregate ()
	Aggregates all channel and log messages informations in the aggregator file.
virtual void	store (LogMessage &message)
	Classifies and stores message internally, according to the corresponding channels they contain.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const
	Returns a user-friendly description of the state of this object.
virtual LogChannel &	createBasicChannel (const std::string &channelName)
	Creates, if possible, a new basic channel whose name is channelName.
virtual ObjectChannel &	createObjectChannel (LogMessage &message)
	Creates, if possible, a new object channel corresponding to the specified Loggable message.
virtual bool	hasChannel (const std::string &channelName) const
	Tells whether this aggregator has already a channel named channelName.
virtual LogChannel *	findChannel (const std::string &channelName) const
	Finds, if any, a channel in LogAggregator's list of channels whose name is channelName.
virtual void	transferChannel (LogChannel &source, LogChannel &target)
	Transfers all the messages of source into target, updates their channel identifier so that it matches the one of target.
virtual void	removeChannel (LogChannel &target)
	Removes completly a log channel.
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 Public Attributes
static const LevelOfDetail	DefaultGlobalLevelOfDetail = Ceylan::Log::DefaultLevelOfDetailForListener
	Default value for the aggregator-wide level of detail.
Protected Member Functions
virtual void	write (const LogChannel &channel) const
	Internal method used to perform the effective writing of log channels into file.
virtual void	write (const LogMessage &message) const
	Internal method used to perform the effective writing of log messages into file.
virtual LogChannel *	findBasicChannel (const std::string &basicChannelName) const
	Finds, if any, a Log channel in LogAggregator's list of channels whose name is channelName.
virtual ObjectChannel *	findObjectChannel (const std::string &nonPrefixedChannelName) const
	Finds, if any, an Object channel in LogAggregator's list of object channels whose short name is channelName (no protocol prefix or separator allowed).
virtual void	createBasicChannelFrom (LogMessage &message)
	Creates a basic (non protocol-prefixed) channel from specified message, which is automatically added to this new channel.
virtual void	createLoggableChannelFrom (LogMessage &message)
	Creates a Loggable channel from specified message.
virtual void	storeBasicMessage (LogMessage &basicLogMessage)
	Classify and stores basic log message basicLogMessage internally, according to the corresponding channel it contains.
virtual void	storeObjectMessage (LogMessage &objectLogMessage)
	Classify and stores object log message objectLogMessage internally, according to the corresponding channel it contains.
virtual void	demangle (LogMessage &objectLogMessage)
	Corrects, if possible, any mangled class name in specified message.
virtual Ceylan::VerbosityLevels	getOverallVerbosityLevel () const
	Returns the most appropriate level of detail for log channel output, depending only on the state of the aggregator.
virtual Ceylan::VerbosityLevels	getMessageVerbosityLevel (const LogMessage &message) const
	Returns the most appropriate level of detail for log message output, depending on the state of the aggregator and on the message's level of detail.
Static Protected Member Functions
static Ceylan::VerbosityLevels	ConvertListenerLevelOfDetailToVerbosityLevel (LevelOfDetail level)
	Converts a level of detail of a log listener into a corresponding verbosity level.
static Ceylan::VerbosityLevels	ConvertMessageLevelOfDetailToVerbosityLevel (LevelOfDetail level)
	Converts a level of detail of a log message into a corresponding verbosity level.
Protected Attributes
std::string	_logFilename
	The file name where log message aggregation should take place.
System::File *	_outputFile
	The file where aggregations will take place.
bool	_immediateWrite
	Tells whether log messages should be written to log file as soon as they are received.
std::list< LogChannel * >	_channelList
	List of all known Log channels.
bool	_beSmart
	Tells whether this aggregator should cope with mangled class names.
bool	_useGlobalLevelOfDetail
	Tells whether a global (aggregator-wide) level of detail for channels should be used.
LevelOfDetail	_globalLevelOfDetail
	Defines the aggregator-wide level of detail, used if _useGlobalLevelOfDetail is set.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
Private Member Functions
	LogAggregatorRaw (const LogAggregatorRaw &source)
	Copy constructor made private to ensure that it will be never called.
LogAggregatorRaw &	operator= (const LogAggregatorRaw &source)
	Assignment operator made private to ensure that it will be never called.