NAP
Public Member Functions | List of all members
LogHandler Class Referenceabstract

#include <nap/logger.h>

Public Member Functions

 LogHandler ()
 
virtual ~LogHandler ()=default
 
virtual void commit (LogMessage msg)=0
 
void setLogLevel (const LogLevel &level)
 
const LogLevelgetLogLevel () const
 
void setFormatter (LogMessageFormatter formatter)
 
std::string formatMessage (LogMessage &msg)
 

Description

Abstract base class for log handlers.

Inheritance diagram for LogHandler:
[legend]

Constructor & Destructor Documentation

◆ LogHandler()

◆ ~LogHandler()

virtual ~LogHandler ( )
virtualdefault

Member Function Documentation

◆ commit()

virtual void commit ( LogMessage  msg)
pure virtual

Let this handler handle a log message. This call must be fast, don't block! WARNING: the implementer must handle thread safety.

Parameters
msgThe log message to be handled

Implemented in FileLogHandler, and ConsoleLogHandler.

◆ formatMessage()

std::string formatMessage ( LogMessage msg)

Format a log message using the currently set log formatter.

Parameters
msgthe message to format
Returns
a formatted log message

◆ getLogLevel()

const LogLevel& getLogLevel ( ) const
Returns
The current log level of this handler, log messages lower than this level will not be handled by this logger.

◆ setFormatter()

void setFormatter ( LogMessageFormatter  formatter)

Override the basic log message formatter

Parameters
formatterthe formatter to use when writing the log message if used by the derived class

◆ setLogLevel()

void setLogLevel ( const LogLevel level)

Set the log level on this handler, log messages lower than the provided level will not be sent to this handler.

Parameters
levelThe minimum level to be sent to this handler