Ceylan::Log::LogAggregatorHTML Class Reference

This class implements thanks to HTML files the LogAggregator interface. More...

#include <CeylanLogAggregatorHTML.h>

Inheritance diagram for Ceylan::Log::LogAggregatorHTML:

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

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

 LogAggregatorHTML (const std::string &callerDescription, const std::string &logDirectoryName, bool useGlobalLevelOfDetail=true, bool beSmart=true)
 Constructs a LogAggregatorHTML which will output incoming log messages in directory specified by logDirectoryname.
virtual ~LogAggregatorHTML () throw ()
 Basic virtual destructor.
virtual void aggregate ()
 Aggregates all channel and log messages informations in the aggregator web pages.
virtual void store (LogMessage &message)
 Classify and stores message internally, according to the corresponding channels it contains.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const
 Returns a user-friendly description of the state of this object.
virtual LogChannelcreateBasicChannel (const std::string &channelName)
 Creates, if possible, a new basic channel whose name is channelName.
virtual ObjectChannelcreateObjectChannel (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 LogChannelfindChannel (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 = MaximumLevelOfDetailForMessage
 Default value for the aggregator-wide level of detail.
static const std::string HTMLPageSuffix = ".html"
 The suffix to add to log output HTML page filenames, typically ".html".

Protected Member Functions

virtual void write (const LogChannel &channel) const
 Internal method used to perform the effective writing of log channels into files.
virtual void write (const LogMessage &message, System::File &targetFile) const
 Internal method used to perform the effective writing of log messages into files.
virtual LogChannelfindBasicChannel (const std::string &basicChannelName) const
 Finds, if any, a Log channel in LogAggregator's list of channels whose name is channelName.
virtual ObjectChannelfindObjectChannel (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 void WriteChannelHeader (const LogChannel &channel, System::File &targetFile)
 Writes a standard HTML header for a channel page.
static void WriteChannelFooter (const LogChannel &channel, System::File &targetFile)
 Writes a standard HTML footer for a channel page.
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 _callerDescription
 A text describing the initiator of this log session, typically the executable name.
std::string _logDirectoryName
 The directory where log message aggregation should take place.
System::Directory_outputDirectory
 The directory where aggregations will take place.
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.
std::list< LogChannel * > _channelList
 List of all known Log channels.
bool _beSmart
 Tells whether this aggregator should cope with mangled class names.

Static Protected Attributes

static const std::string FrameSet
 The HTML static content for frameset.
static const std::string DefaultPageHeader
 The HTML header for the default web page.
static const std::string DefaultPageFooter
 The HTML footer for the default web page.
static const std::string MenuHeader
 The HTML header for browser menu web pages.
static const std::string MenuFooter
 The HTML footer for browser menu web pages.
static const std::string ChannelHeader
 The HTML header for channel web pages.
static const std::string ChannelFooter
 The HTML footer for channel web pages.
static TextOutputFormat _OutputFormat = rawText
 The text format to be used currently by TextDisplayable instances.

Private Member Functions

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


Detailed Description

This class implements thanks to HTML files the LogAggregator interface.

The Log messages are stored in the web page corresponding to their channel.

Note:
Log messages used to be filtered by Ceylan::encodeToHTML, so that '>' and '<' for example did not mess with the log output. This functionality has been rolled back, since it prevented us from using HTML code on purpose, for example in order to send HTML list in the logs.
Todo:
Maybe add the log session name in the HTML page name so that it remains visible when using multiple browser tabs/windows, instead of 'Ceylan - Log browser'.
See also:
LogAggregator

Definition at line 78 of file CeylanLogAggregatorHTML.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

LogAggregatorHTML::LogAggregatorHTML ( const std::string &  callerDescription,
const std::string &  logDirectoryName,
bool  useGlobalLevelOfDetail = true,
bool  beSmart = true 
) [explicit]

Constructs a LogAggregatorHTML which will output incoming log messages in directory specified by logDirectoryname.

Parameters:
callerDescription A text describing the initiator of this log session, typically the executable name.
logDirectoryname The directory where log pages should be stored.
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 due to C++ name mangling.
Exceptions:
LogAggregatorException if the construction failed.

Definition at line 70 of file CeylanLogAggregatorHTML.cc.

References _logDirectoryName, _outputDirectory, CEYLAN_LOG, Ceylan::System::Directory::Create(), dataUtils::e, and Ceylan::Exception::toString().

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

Ceylan::Log::LogAggregatorHTML::LogAggregatorHTML ( const LogAggregatorHTML 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 LogAggregatorHTML::aggregate (  )  [virtual]

Aggregates all channel and log messages informations in the aggregator web pages.

Note:
This method does nothing if the immediate write flag is turned on: work should be already done in this case.
Exceptions:
LogAggregatorException if the operation failed.

Implements Ceylan::Log::LogAggregator.

Definition at line 141 of file CeylanLogAggregatorHTML.cc.

References _callerDescription, Ceylan::Log::LogAggregator::_channelList, _outputDirectory, CEYLAN_LOG, DefaultPageFooter, DefaultPageHeader, dataUtils::e, Ceylan::encodeToHTML(), FrameSet, Ceylan::System::Directory::getPath(), Ceylan::Log::LogPlug::GetSourceName(), HTMLPageSuffix, MenuFooter, MenuHeader, Ceylan::substituteInString(), Ceylan::Exception::toString(), Ceylan::toString(), toString(), Ceylan::Timestamp::toString(), write(), and Ceylan::System::File::write().

Referenced by ~LogAggregatorHTML().

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]

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

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 Ceylan::Log::LogAggregatorRaw::write(), and Ceylan::Log::LogAggregatorConsole::write().

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

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 Ceylan::Log::LogAggregatorRaw::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().

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

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 LogAggregatorHTML::store ( LogMessage message  )  [virtual]

Classify and stores message internally, according to the corresponding channels it contains.

Note:
This implementation, if immediateWrite mode is selected, will immediatly write this message to corresponding channel web 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 268 of file CeylanLogAggregatorHTML.cc.

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

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 LogAggregatorHTML::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 280 of file CeylanLogAggregatorHTML.cc.

Referenced by aggregate().

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 LogAggregatorHTML::write ( const LogMessage message,
System::File targetFile 
) const [protected, virtual]

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

Parameters:
channel 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 340 of file CeylanLogAggregatorHTML.cc.

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

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

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

Parameters:
channel the log channel to write.
Exceptions:
LogException if the write operation failed.

Definition at line 295 of file CeylanLogAggregatorHTML.cc.

References _globalLevelOfDetail, Ceylan::Log::LogChannel::_messages, _outputDirectory, _useGlobalLevelOfDetail, CEYLAN_LOG, Ceylan::Log::LogChannel::getName(), Ceylan::System::Directory::getPath(), Ceylan::high, HTMLPageSuffix, Ceylan::Log::MaximumLevelOfDetailForMessage, Ceylan::Log::LogChannel::toString(), Ceylan::toString(), WriteChannelFooter(), and WriteChannelHeader().

Referenced by aggregate().

void LogAggregatorHTML::WriteChannelFooter ( const LogChannel channel,
System::File targetFile 
) [static, protected]

Writes a standard HTML footer for a channel page.

Parameters:
channel 
targetFile the log channel page to write in.
See also:
ChannelFooter
Exceptions:
LogException if the write operation failed.

Definition at line 397 of file CeylanLogAggregatorHTML.cc.

References ChannelFooter, dataUtils::e, Ceylan::encodeToHTML(), Ceylan::System::getTime(), Ceylan::substituteInString(), Ceylan::System::timeToString(), Ceylan::Exception::toString(), and Ceylan::System::File::write().

Referenced by write().

void LogAggregatorHTML::WriteChannelHeader ( const LogChannel channel,
System::File targetFile 
) [static, protected]

Writes a standard HTML header for a channel page.

Parameters:
targetFile the log channel page to write in.
See also:
ChannelHeader
Exceptions:
LogException if the write operation failed.

Definition at line 371 of file CeylanLogAggregatorHTML.cc.

References ChannelHeader, dataUtils::e, Ceylan::encodeToHTML(), Ceylan::Log::LogChannel::getName(), Ceylan::substituteInString(), Ceylan::Exception::toString(), and Ceylan::System::File::write().

Referenced by write().


Member Data Documentation

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

A text describing the initiator of this log session, typically the executable name.

Definition at line 261 of file CeylanLogAggregatorHTML.h.

Referenced by aggregate().

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

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

Reimplemented from Ceylan::Log::LogAggregator.

Definition at line 291 of file CeylanLogAggregatorHTML.h.

Referenced by write().

The directory where log message aggregation should take place.

Definition at line 269 of file CeylanLogAggregatorHTML.h.

Referenced by LogAggregatorHTML().

The directory where aggregations will take place.

Definition at line 273 of file CeylanLogAggregatorHTML.h.

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

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

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 from Ceylan::Log::LogAggregator.

Definition at line 283 of file CeylanLogAggregatorHTML.h.

Referenced by write().

const std::string Ceylan::Log::LogAggregatorHTML::ChannelFooter [static, protected]

The HTML footer for channel web pages.

Definition at line 316 of file CeylanLogAggregatorHTML.h.

Referenced by WriteChannelFooter().

const std::string Ceylan::Log::LogAggregatorHTML::ChannelHeader [static, protected]

The HTML header for channel web pages.

Definition at line 313 of file CeylanLogAggregatorHTML.h.

Referenced by WriteChannelHeader().

Default value for the aggregator-wide level of detail.

Reimplemented from Ceylan::Log::LogAggregator.

Definition at line 173 of file CeylanLogAggregatorHTML.h.

const std::string Ceylan::Log::LogAggregatorHTML::DefaultPageFooter [static, protected]

The HTML footer for the default web page.

Definition at line 302 of file CeylanLogAggregatorHTML.h.

Referenced by aggregate().

const std::string Ceylan::Log::LogAggregatorHTML::DefaultPageHeader [static, protected]

The HTML header for the default web page.

Definition at line 299 of file CeylanLogAggregatorHTML.h.

Referenced by aggregate().

const std::string Ceylan::Log::LogAggregatorHTML::FrameSet [static, protected]

The HTML static content for frameset.

Definition at line 295 of file CeylanLogAggregatorHTML.h.

Referenced by aggregate().

const string LogAggregatorHTML::HTMLPageSuffix = ".html" [static]

The suffix to add to log output HTML page filenames, typically ".html".

Definition at line 182 of file CeylanLogAggregatorHTML.h.

Referenced by aggregate(), and write().

const std::string Ceylan::Log::LogAggregatorHTML::MenuFooter [static, protected]

The HTML footer for browser menu web pages.

Definition at line 309 of file CeylanLogAggregatorHTML.h.

Referenced by aggregate().

const std::string Ceylan::Log::LogAggregatorHTML::MenuHeader [static, protected]

The HTML header for browser menu web pages.

Definition at line 306 of file CeylanLogAggregatorHTML.h.

Referenced by aggregate().


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

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