Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
LogMessageData Class Reference

A class that stores log messages. More...

#include <log_message_data.h>

Public Member Functions

 LogMessageData (const LogLevel level, const std::string &message, const std::string &function, const std::string &file, int32_t line, const std::shared_ptr< void > &context, std::chrono::time_point< std::chrono::system_clock > messageTime, std::thread::id messageThreadId)
 
LogLevel GetLevel () const
 The log level for the log statement.
 
const std::string & GetLogMessage () const
 The message for the log statement.
 
const std::string & GetFunction () const
 The function name for the log statement.
 
const std::string & GetFile () const
 The file name for the log statement.
 
int32_t GetLine () const
 The line number for the log statement.
 
const std::shared_ptr< void > & GetContext () const
 The logger context for the log statement.
 
std::chrono::time_point< std::chrono::system_clock > GetMessageTime () const
 The message time of the log statement.
 
std::thread::id GetMessageThreadId () const
 The thread id of the log statement.
 

Private Attributes

LogLevel mLevel
 
std::string mLogMessage
 
std::string mFunction
 
std::string mFile
 
int32_t mLine
 
std::shared_ptr< void > mContext
 
std::chrono::time_point< std::chrono::system_clock > mMessageTime
 
std::thread::id mMessageThreadId
 

Detailed Description

A class that stores log messages.

Constructor & Destructor Documentation

◆ LogMessageData()

LogMessageData::LogMessageData ( const LogLevel level,
const std::string & message,
const std::string & function,
const std::string & file,
int32_t line,
const std::shared_ptr< void > & context,
std::chrono::time_point< std::chrono::system_clock > messageTime,
std::thread::id messageThreadId )
inline

Member Function Documentation

◆ GetContext()

const std::shared_ptr< void > & LogMessageData::GetContext ( ) const
inline

The logger context for the log statement.

◆ GetFile()

const std::string & LogMessageData::GetFile ( ) const
inline

The file name for the log statement.

◆ GetFunction()

const std::string & LogMessageData::GetFunction ( ) const
inline

The function name for the log statement.

◆ GetLevel()

LogLevel LogMessageData::GetLevel ( ) const
inline

The log level for the log statement.

◆ GetLine()

int32_t LogMessageData::GetLine ( ) const
inline

The line number for the log statement.

◆ GetLogMessage()

const std::string & LogMessageData::GetLogMessage ( ) const
inline

The message for the log statement.

◆ GetMessageThreadId()

std::thread::id LogMessageData::GetMessageThreadId ( ) const
inline

The thread id of the log statement.

◆ GetMessageTime()

std::chrono::time_point< std::chrono::system_clock > LogMessageData::GetMessageTime ( ) const
inline

The message time of the log statement.

Member Data Documentation

◆ mContext

std::shared_ptr<void> LogMessageData::mContext
private

◆ mFile

std::string LogMessageData::mFile
private

◆ mFunction

std::string LogMessageData::mFunction
private

◆ mLevel

LogLevel LogMessageData::mLevel
private

◆ mLine

int32_t LogMessageData::mLine
private

◆ mLogMessage

std::string LogMessageData::mLogMessage
private

◆ mMessageThreadId

std::thread::id LogMessageData::mMessageThreadId
private

◆ mMessageTime

std::chrono::time_point<std::chrono::system_clock> LogMessageData::mMessageTime
private

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