LoggerDelegate Class Reference

A class that defines the interface to the MIP SDK logger. More...

#include <src/api/mip/logger_delegate.h>

Public Member Functions
virtual void	Flush ()=0
	Flush the logger.
virtual void	Init (const std::string &storagePath)=0
	Initialize 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.
virtual void	WriteToLogWithLogMessage (const LogMessageData &logMessage)
	Write a log statement to a log.

Detailed Description

A class that defines the interface to the MIP SDK logger.

Definition at line 49 of file logger_delegate.h.

Member Function Documentation

Flush()

virtual void LoggerDelegate::Flush ( )

pure virtual

Flush the logger.

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.

Referenced by WriteToLogWithContext().

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

Definition at line 87 of file logger_delegate.h.

                                    {
    WriteToLog(level, message, function, file, line);
  }

References WriteToLog().

Referenced by WriteToLogWithLogMessage().

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

Definition at line 102 of file logger_delegate.h.

                                                                          {
    WriteToLogWithContext(
        logMessage.GetLevel(),
        logMessage.GetLogMessage(),
        logMessage.GetFunction(),
        logMessage.GetFile(),
        logMessage.GetLine(),
        logMessage.GetContext());
  }

References LogMessageData::GetContext(), LogMessageData::GetFile(), LogMessageData::GetFunction(), LogMessageData::GetLevel(), LogMessageData::GetLine(), LogMessageData::GetLogMessage(), and WriteToLogWithContext().

---

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

• src/api/mip/logger_delegate.h