Cogs::Logging::RedirectedLogger Class Reference

RedirectedLogger is a message consumer that forwards any incoming message to the callback functions registered with it. More...

#include <RedirectedLogger.h>

Inheritance diagram for Cogs::Logging::RedirectedLogger:

Public Member Functions
void	setLoggerCallback (LoggerCallback *callback)
void	setFileLineLoggerCallback (FileLineLoggerCallback *callback)
LoggerCallback *	getLoggerCallback ()
FileLineLoggerCallback *	getFileLineLoggerCallback ()
Public Member Functions inherited from Cogs::Logging::Consumer
	Consumer ()
	Constructs a new Consumer instance.
virtual	~Consumer ()
	Unregisters this consumer from the LogManager and destroys this instance.
virtual void	consumeMessage (const char *source, Category category, uint32_t errorNumber, const char *message, const char *filename, int lineNumber)=0
Category	getMinimumCategory () const
void	setMinimumCategory (Category category)
	Set the minimum category level of messages that this consumer will output.
void	enableFilenames (bool enable)

Private Member Functions
virtual void	consumeMessage (const char *source, Category category, uint32_t errorNumber, const char *message, const char *filename, int lineNumber) override

Private Attributes
LoggerCallback *	loggerCallback = nullptr
FileLineLoggerCallback *	fileLineLoggerCallback = nullptr

Additional Inherited Members
Static Public Member Functions inherited from Cogs::Logging::Consumer
static void	setDefaultMinimumCategory (Category category)
	Sets the default minimum category for all future consumers.
static const char *	getCategoryName (Category category)
	Retrieves a human-friendly name for the given category level.
static const char *	getCategoryNameColor (Category category)
Protected Attributes inherited from Cogs::Logging::Consumer
Mutex	mutex
	Mutex available for implementations to use if needed.
bool	outputFilenames = false
	Flag controlling whether or not to include the filenames for message sources.

Detailed Description

RedirectedLogger is a message consumer that forwards any incoming message to the callback functions registered with it.

This class exists primarily as a proxy between the LogManager and the Cogs bridge, but could be used anywhere.

Member Function Documentation

consumeMessage()

void Cogs::Logging::RedirectedLogger::consumeMessage ( const char *  source, Category  category, uint32_t  errorNumber, const char *  message, const char *  filename, int  lineNumber  )

overrideprivatevirtual

Implements Cogs::Logging::Consumer.

References fileLineLoggerCallback, and loggerCallback.

getFileLineLoggerCallback()

FileLineLoggerCallback * Cogs::Logging::RedirectedLogger::getFileLineLoggerCallback ( )

inline

getLoggerCallback()

LoggerCallback * Cogs::Logging::RedirectedLogger::getLoggerCallback ( )

inline

setFileLineLoggerCallback()

void Cogs::Logging::RedirectedLogger::setFileLineLoggerCallback ( FileLineLoggerCallback *  callback )

inline

setLoggerCallback()

void Cogs::Logging::RedirectedLogger::setLoggerCallback ( LoggerCallback *  callback )

inline

Member Data Documentation

fileLineLoggerCallback

FileLineLoggerCallback* Cogs::Logging::RedirectedLogger::fileLineLoggerCallback = nullptr

private

Referenced by consumeMessage().

loggerCallback

LoggerCallback* Cogs::Logging::RedirectedLogger::loggerCallback = nullptr

private

Referenced by consumeMessage().

---

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

• Source/Logging/RedirectedLogger.h
• Source/Logging/RedirectedLogger.cpp