Mdt::ErrorLogger::Logger Class Reference

Helper class to log Error objects. More...

#include <Logger.h>

Inherits QObject.

Public Types

Static Public Member Functions
template<typename T >
static T *	addBackend (ExecutionThread executionThread)
	Add a logger backend. More...
static void	logError (const Error &error)
	Log given error. More...
static void	cleanup ()
	Cleanup. More...

Detailed Description

Helper class to log Error objects.

Definition at line 42 of file Logger.h.

Member Enumeration Documentation

enum Mdt::ErrorLogger::Logger::ExecutionThread

Execution thread of a backend.

When adding a backend to the logger, it is possible to choose in which thread it must run.

Enumerator
ExecuteInMainThread	The backend will run in the main thread. The Qt's signal/slot is used with a auto connection, so that errors logged using logError() will allways call Backend::logError() from the main thread event loop, regardless of the caller thread.
ExecuteInSeparateThread	The backend will run in logger's separate thread. A call to logError() will allways just queue the error and return. The logger's separated thread will then call Backend::logError().

Definition at line 54 of file Logger.h.

Member Function Documentation

template<typename T >

static T* Mdt::ErrorLogger::Logger::addBackend ( ExecutionThread  executionThread )

inlinestatic

Add a logger backend.

using Mdt::ErrorLogger::Logger;

auto backend = Logger::addBackend<FileBackend>(Logger::ExecuteInSeparateThread);
backend->setLogFilePath("some/path/to/logfile");

A backend of type T is instanciated and added to the list of backends runing on specified executionThread . A pointer to the created backend is returned, so that some setup can be done on the backend. The logger has the ownership of the backend (it will delete it).

Accessing the backend referenced by the returned pointer is only possible:

• If it runs on separate thread, before any error is logged ( by calling logError() )
• For all cases, before calling cleanup()

Definition at line 95 of file Logger.h.

void Mdt::ErrorLogger::Logger::cleanup ( )

static

Cleanup.

Note

This function must be called before returning from main(). Not doing so conducts to undefined behaviour. Consider using a LoggerGuard.

Definition at line 36 of file Logger.cpp.

void Mdt::ErrorLogger::Logger::logError ( const Error &  error )

static

Log given error.

This function is thread safe

Precondition

error must not be null

Definition at line 28 of file Logger.cpp.

---

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

• libs/Error_Core/src/Mdt/ErrorLogger/Logger.h
• libs/Error_Core/src/Mdt/ErrorLogger/Logger.cpp