Diarkis C++Client Library API Document
ThreadedLoggerBackend Class Reference

Class for outputting logs using threads. More...

#include <ThreadedLoggerBackend.h>

Inheritance diagram for ThreadedLoggerBackend:
Collaboration diagram for ThreadedLoggerBackend:

Public Member Functions

 ThreadedLoggerBackend (std::shared_ptr< ILoggerBackend > loggerBackend, bool bDirect=false)
 Constructor for ThreadedLoggerBackend. More...
 
virtual ~ThreadedLoggerBackend ()
 ThreadedLoggerBackend destructor. More...
 
void Stop ()
 Stop the logging thread. More...
 
Result Log (const Diarkis::StdString &message, bool includeNewLine=true) override
 Outputs a log of specified messages. More...
 

Detailed Description

Class for outputting logs using threads.

Constructor & Destructor Documentation

◆ ThreadedLoggerBackend()

ThreadedLoggerBackend::ThreadedLoggerBackend ( std::shared_ptr< ILoggerBackend loggerBackend,
bool  bDirect = false 
)

Constructor for ThreadedLoggerBackend.

Create a thread to write logs.

Parameters
[in]loggerBackendPointer to ILoggerBackend that manages logs to be output
[in]bDirectWhether to output directly without using a thread. This is for debug.

◆ ~ThreadedLoggerBackend()

ThreadedLoggerBackend::~ThreadedLoggerBackend ( )
virtual

ThreadedLoggerBackend destructor.

Member Function Documentation

◆ Stop()

void ThreadedLoggerBackend::Stop ( )

Stop the logging thread.

◆ Log()

Result ThreadedLoggerBackend::Log ( const Diarkis::StdString message,
bool  includeNewLine = true 
)
overridevirtual

Outputs a log of specified messages.

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

Implements ILoggerBackend.


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