DDraceNetwork Docs
ILogger Class Referenceabstract

#include <logger.h>

Inheritance diagram for ILogger:
[legend]
Collaboration diagram for ILogger:
[legend]

Public Member Functions

virtual ~ILogger ()
 
void SetFilter (const CLogFilter &Filter)
 
virtual void Log (const CLogMessage *pMessage)=0
 
virtual void GlobalFinish ()
 
virtual void OnFilterChange ()
 

Protected Attributes

CLogFilter m_Filter
 

Constructor & Destructor Documentation

◆ ~ILogger()

virtual ILogger::~ILogger ( )
inlinevirtual

Member Function Documentation

◆ GlobalFinish()

virtual void ILogger::GlobalFinish ( )
inlinevirtual

Flushes output buffers and shuts down. Global loggers cannot be destroyed because they might be accessed from multiple threads concurrently.

This function is called on the global logger by log_global_logger_finish when the program is about to shut down and loggers are supposed to finish writing the log messages they have received so far.

The destructor of this ILogger instance will not be called if this function is called.

See also
log_global_logger_finish

Reimplemented in CLoggerCollection, CLoggerAsync, CFutureLogger, and CAssertionLogger.

◆ Log()

virtual void ILogger::Log ( const CLogMessage pMessage)
pure virtual

Send the specified message to the logging backend.

Parameters
pMessageStruct describing the log message.

Implemented in CLoggerCollection, CLoggerAsync, CLoggerNoOp, CFutureLogger, CRconClientLogger, CClientChatLogger, CConsoleLogger, CAssertionLogger, and CServerLogger.

◆ OnFilterChange()

virtual void ILogger::OnFilterChange ( )
inlinevirtual

Notifies the logger of a changed m_Filter.

Reimplemented in CFutureLogger.

◆ SetFilter()

void ILogger::SetFilter ( const CLogFilter Filter)
inline

Set a new filter. It's up to the logger implementation to actually use the filter.

Member Data Documentation

◆ m_Filter

CLogFilter ILogger::m_Filter
protected

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