Diarkis C++Client Library API Document
Diarkis::IDiarkisLogger Class Referenceabstract

Interface class for manipulating logging functions. More...

#include <Logger.h>

Inheritance diagram for Diarkis::IDiarkisLogger:

Public Member Functions

virtual const StdString GetCategory ()=0
 Get log category. More...
 
virtual DiarkisLoggerSeverity GetSeverity ()=0
 Get the current log severity. More...
 
virtual void SetSeverity (DiarkisLoggerSeverity severity)=0
 Set new log severity. More...
 
virtual void SetServerType (const StdString &type)=0
 Configure a server type to be included in log output. More...
 
virtual size_t GetTraceOutputBytes ()=0
 Get the current maximum size of the payload to be dumped at DiarkisLoggerSeverity::Trace log level. More...
 
virtual void SetTraceOutputBytes (size_t bytes)=0
 Specifies the maximum size of the payload to be dumped at DiarkisLoggerSeverity::Trace log level. More...
 
virtual void Log (DiarkisLoggerSeverity severity, const StdString &message, bool includeNewLine=true)=0
 Log output. More...
 

Detailed Description

Interface class for manipulating logging functions.

This class has functions to set log severity and perform log output.

Member Function Documentation

◆ GetCategory()

virtual const StdString Diarkis::IDiarkisLogger::GetCategory ( )
pure virtual

Get log category.

Implemented in DelegateLogger.

◆ GetSeverity()

virtual DiarkisLoggerSeverity Diarkis::IDiarkisLogger::GetSeverity ( )
pure virtual

Get the current log severity.

Implemented in DelegateLogger.

◆ SetSeverity()

virtual void Diarkis::IDiarkisLogger::SetSeverity ( DiarkisLoggerSeverity  severity)
pure virtual

Set new log severity.

Implemented in DelegateLogger.

◆ SetServerType()

virtual void Diarkis::IDiarkisLogger::SetServerType ( const StdString type)
pure virtual

Configure a server type to be included in log output.

Implemented in DelegateLogger.

◆ GetTraceOutputBytes()

virtual size_t Diarkis::IDiarkisLogger::GetTraceOutputBytes ( )
pure virtual

Get the current maximum size of the payload to be dumped at DiarkisLoggerSeverity::Trace log level.

Implemented in DelegateLogger.

◆ SetTraceOutputBytes()

virtual void Diarkis::IDiarkisLogger::SetTraceOutputBytes ( size_t  bytes)
pure virtual

Specifies the maximum size of the payload to be dumped at DiarkisLoggerSeverity::Trace log level.

Implemented in DelegateLogger.

◆ Log()

virtual void Diarkis::IDiarkisLogger::Log ( DiarkisLoggerSeverity  severity,
const StdString message,
bool  includeNewLine = true 
)
pure virtual

Log output.

Parameters
[in]severitySeverity level of logging
[in]messageMessage to log output
[in]includeNewLineWhether to add a new line or not true=include

Implemented in DelegateLogger.


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