LoggerConsole Class Reference

#include <evo/logger_console.h>

Inheritance diagram for LoggerConsole:

Detailed Description

Logger that writes to console.

• Use to log to stderr instead of a file
• This is thread safe – uses ConsoleMT
• This blocks while writing to stderr so when performance is important use Logger instead

Public Member Functions
	LoggerConsole (LogLevel level=LOG_LEVEL_WARN)
	Constructor. More...
bool	check (LogLevel level) const
	Check whether a message with given level will actually be logged. More...
virtual bool	get_error (String &msg)
	Get last error that occurred. More...
bool	log (LogLevel level, const SubString &msg)
	Log a message with given severity level. More...
void	log_direct (LogLevel level, const SubString &msg)
	Log a message with given log level directly without checking the current log level. More...
virtual void	rotate ()
	Set log rotation flag. More...
virtual void	set_level (LogLevel level)
	Set current log level. More...

Protected Attributes
AtomicInt	level_
	Log level, messages less severe than this are ignored (not logged) More...

Constructor & Destructor Documentation

LoggerConsole()

LoggerConsole ( LogLevel  level = LOG_LEVEL_WARN )

inline

Constructor.

Parameters

level

Log level to use – see LogLevel

Member Function Documentation

check()

bool check ( LogLevel  level ) const

inlineinherited

Check whether a message with given level will actually be logged.

• This is used before calling log_direct() with the message
• Consider using helper macros:
  • EVO_LOG_ALERT()
  • EVO_LOG_ERROR()
  • EVO_LOG_WARN()
  • EVO_LOG_INFO()
  • EVO_LOG_DEBUG()
  • EVO_LOG_DEBUG_LOW()

Parameters

level

Message severity level to check

Returns

Whether given severity level passes current level check, false if a message at this level will be ignored

get_error()

virtual bool get_error ( String &  msg )

inlinevirtualinherited

Get last error that occurred.

• This resets the error message so calling again returns false, unless another error occurred

Parameters

msg	Stores last error message, null if none [out]

Returns

Whether an error occurred, true if error message stored in msg

Reimplemented in Logger< MSG_BUF_SIZE >.

log()

bool log ( LogLevel  level, const SubString &  msg  )

inlineinherited

Log a message with given severity level.

• This calls check() to check whether this message will be logged
• For best performance use check() and log_direct() instead to avoid formatting messages that will not be logged
• Consider using helper macros:
  • EVO_LOG_ALERT()
  • EVO_LOG_ERROR()
  • EVO_LOG_WARN()
  • EVO_LOG_INFO()
  • EVO_LOG_DEBUG()
  • EVO_LOG_DEBUG_LOW()

Parameters

level	Message severity level to use
msg	Message to log

Returns

Whether message was logged, false if message will be ignored due to current log level

log_direct()

void log_direct ( LogLevel  level, const SubString &  msg  )

inlinevirtual

Log a message with given log level directly without checking the current log level.

• This assumes check() was called first to check whether message will be logged
• Consider using helper macros:
  • EVO_LOG_ALERT()
  • EVO_LOG_ERROR()
  • EVO_LOG_WARN()
  • EVO_LOG_INFO()
  • EVO_LOG_DEBUG()
  • EVO_LOG_DEBUG_LOW()

Parameters

level	Message severity level to use
msg	Message to log

Implements LoggerBase.

rotate()

virtual void rotate ( )

inlinevirtualinherited

Set log rotation flag.

• This tells the logging thread to close and re-open the log file between messages
• Linux: Usually called from SIGHUP handler triggered by something like the standard logrotate tool

Reimplemented in Logger< MSG_BUF_SIZE >.

set_level()

virtual void set_level ( LogLevel  level )

inlinevirtualinherited

Set current log level.

• Log messages with a less severe level than this are ignored (not logged)

Parameters

level

Log level to use – see LogLevel

Member Data Documentation

level_

AtomicInt level_

protectedinherited

Log level, messages less severe than this are ignored (not logged)

---

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

• evo/logger_console.h