![]() |
Open Lighting Architecture 0.10.9
|
The OLA logging system.
Files | |
| file | Logging.cpp |
| file | Logging.h |
| Header file for OLA Logging. | |
Namespaces | |
| namespace | ola |
| The namespace containing all OLA symbols. | |
Macros | |
| #define | OLA_LOG(level) |
| #define | OLA_FATAL OLA_LOG(ola::OLA_LOG_FATAL) |
| #define | OLA_WARN OLA_LOG(ola::OLA_LOG_WARN) |
| #define | OLA_INFO OLA_LOG(ola::OLA_LOG_INFO) |
| #define | OLA_DEBUG OLA_LOG(ola::OLA_LOG_DEBUG) |
Functions | |
| void | ola::SetLogLevel (log_level level) |
| Set the logging level. | |
| void | ola::IncrementLogLevel () |
| Increment the log level by one. The log level wraps to OLA_LOG_NONE. | |
| bool | ola::InitLoggingFromFlags () |
| Initialize the OLA logging system from flags. | |
| bool | ola::InitLogging (log_level level, log_output output) |
| Initialize the OLA logging system. | |
| void | ola::InitLogging (log_level level, LogDestination *destination) |
| Initialize the OLA logging system using the specified LogDestination. | |
| virtual | ola::LogDestination::~LogDestination () |
| Destructor. | |
| virtual void | ola::LogDestination::Write (log_level level, const std::string &log_line)=0 |
| An abstract function for writing to your log destination. | |
| void | ola::StdErrorLogDestination::Write (log_level level, const std::string &log_line) |
| Writes a messages out to stderr. | |
| virtual | ola::SyslogDestination::~SyslogDestination () |
| Destructor. | |
| virtual bool | ola::SyslogDestination::Init ()=0 |
| Initialize the SyslogDestination. | |
| virtual void | ola::SyslogDestination::Write (log_level level, const std::string &log_line)=0 |
| Write a line to the system logger. | |
| bool | ola::UnixSyslogDestination::Init () |
| Initialize the UnixSyslogDestination. | |
| void | ola::UnixSyslogDestination::Write (log_level level, const std::string &log_line) |
| Write a line to syslog. | |
| log_level | ola::LogLevel () |
| Fetch the current level of logging. | |
| #define OLA_DEBUG OLA_LOG(ola::OLA_LOG_DEBUG) |
Provide a stream to log a debug message.
| #define OLA_FATAL OLA_LOG(ola::OLA_LOG_FATAL) |
Provide a stream to log a fatal message. e.g.
| #define OLA_INFO OLA_LOG(ola::OLA_LOG_INFO) |
Provide a stream to log an informational message.
| #define OLA_LOG | ( | level | ) |
Provide a stream interface to log a message at the specified log level. Rather than calling this directly use one of the OLA_FATAL, OLA_WARN, OLA_INFO or OLA_DEBUG macros.
| level | the log_level to log at. |
| #define OLA_WARN OLA_LOG(ola::OLA_LOG_WARN) |
Provide a stream to log a warning message.
|
pure virtual |
Initialize the SyslogDestination.
Implemented in ola::UnixSyslogDestination.
|
virtual |
Initialize the UnixSyslogDestination.
Implements ola::SyslogDestination.
| bool ola::InitLogging | ( | log_level | level, |
| log_output | output ) |
Initialize the OLA logging system.
| level | the level to log at |
| output | the destination for the logs |
| void ola::InitLogging | ( | log_level | level, |
| LogDestination * | destination ) |
Initialize the OLA logging system using the specified LogDestination.
| level | the level to log at |
| destination | the LogDestination to use. |
| bool ola::InitLoggingFromFlags | ( | ) |
Initialize the OLA logging system from flags.
|
inline |
Fetch the current level of logging.
| void ola::SetLogLevel | ( | log_level | level | ) |
Set the logging level.
| level | the new log_level to use. |
|
pure virtual |
An abstract function for writing to your log destination.
Implemented in ola::StdErrorLogDestination, ola::SyslogDestination, and ola::UnixSyslogDestination.
|
virtual |
Writes a messages out to stderr.
Implements ola::LogDestination.
|
pure virtual |
Write a line to the system logger.
Implements ola::LogDestination.
Implemented in ola::UnixSyslogDestination.
|
virtual |
Write a line to syslog.
Implements ola::SyslogDestination.