#include <evo/logger.h>
Base class for Logger.
- This gives a common logging interface
- Call set_level() to set logging level – messages less severe than this level are ignored (not logged)
- Call log() or log_direct() to log messages from any thread, or use the helper macros:
- See: Logger, LoggerConsole
◆ ~LoggerBase()
◆ check()
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:
- 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 | ) |
|
|
inlinevirtual |
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()
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:
- 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()
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:
- Parameters
-
level | Message severity level to use |
msg | Message to log |
Implemented in Logger< MSG_BUF_SIZE >, and LoggerConsole.
◆ rotate()
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 | ) |
|
|
inlinevirtual |
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 |
◆ level_
Log level, messages less severe than this are ignored (not logged)
The documentation for this class was generated from the following file: