A class that defines the interface to the MIP SDK logger.
More...
#include <logger_delegate.h>
|
virtual void | Init (const std::string &storagePath)=0 |
| Initialize the logger.
|
|
virtual void | Flush ()=0 |
| Flush the logger.
|
|
virtual void | WriteToLog (const LogLevel level, const std::string &message, const std::string &function, const std::string &file, const int32_t line)=0 |
| Write a log statement to log file.
|
|
virtual void | WriteToLogWithContext (const LogLevel level, const std::string &message, const std::string &function, const std::string &file, const int32_t line, const std::shared_ptr< void > &) |
| Write a log statement to log file with a context. Override this function to handle the context.
|
|
virtual void | WriteToLogWithLogMessage (const LogMessageData &logMessage) |
| Write a log statement to a log.
|
|
A class that defines the interface to the MIP SDK logger.
◆ Flush()
virtual void LoggerDelegate::Flush |
( |
| ) |
|
|
pure virtual |
◆ Init()
virtual void LoggerDelegate::Init |
( |
const std::string & | storagePath | ) |
|
|
pure virtual |
Initialize the logger.
- Parameters
-
storagePath | the path to the location where persistent state, including logs, may be stored. |
◆ WriteToLog()
virtual void LoggerDelegate::WriteToLog |
( |
const LogLevel | level, |
|
|
const std::string & | message, |
|
|
const std::string & | function, |
|
|
const std::string & | file, |
|
|
const int32_t | line ) |
|
pure virtual |
Write a log statement to log file.
- Parameters
-
level | the log level for the log statement. |
message | the message for the log statement. |
function | the function name for the log statement. |
file | the file name where log statement was generated. |
line | the line number where the log statement was generated. |
◆ WriteToLogWithContext()
virtual void LoggerDelegate::WriteToLogWithContext |
( |
const LogLevel | level, |
|
|
const std::string & | message, |
|
|
const std::string & | function, |
|
|
const std::string & | file, |
|
|
const int32_t | line, |
|
|
const std::shared_ptr< void > & | ) |
|
inlinevirtual |
Write a log statement to log file with a context. Override this function to handle the context.
- Parameters
-
level | the log level for the log statement. |
message | the message for the log statement. |
function | the function name for the log statement. |
file | the file name where log statement was generated. |
line | the line number where the log statement was generated. |
context | Client context that was passed into the call that generated this log message |
◆ WriteToLogWithLogMessage()
virtual void LoggerDelegate::WriteToLogWithLogMessage |
( |
const LogMessageData & | logMessage | ) |
|
|
inlinevirtual |
Write a log statement to a log.
- Parameters
-
logMessage | The log message data containing the logging information |
The documentation for this class was generated from the following file: