#include <Backend.h>

Inheritance diagram for Mdt::ErrorLogger::Backend:

Public Member Functions
	Backend (QObject *parent=nullptr)
	Constructor.

	~Backend ()
	Destructor.

template<typename T >
void	setFormatEngine ()
	Set the format engine. More...

virtual void	cleanup ()
	Called during end cleanup. More...

Protected Member Functions
QString	formatError (const Mdt::Error &error) const
	Format error to its string representation. More...

Detailed Description

This class is a interface to create a error logger backend that will be used by error Logger to output errors.

Notice that Logger can be executed from a non main thread, also take care that some functions must at least be reentrant.

Definition at line 45 of file Backend.h.

Member Function Documentation

virtual void Mdt::ErrorLogger::Backend::cleanup ( )

inlinevirtual

Called during end cleanup.

This method is called from Logger::cleanup().

Backend can implement this method if requierd.

This default implementation does nothing.

Definition at line 90 of file Backend.h.

QString Mdt::ErrorLogger::Backend::formatError ( const Mdt::Error & error ) const

protected

Format error to its string representation.

Will use the format engine set using setFormatEngine().

Precondition: A format engine must have been set before calling this method.

Definition at line 35 of file Backend.cpp.

virtual void Mdt::ErrorLogger::Backend::logError ( const Error & error )

pure virtualslot

Log given error.

This method must be reentrant, because it can be called from Logger thread (which is not the main thread).

template<typename T >

void Mdt::ErrorLogger::Backend::setFormatEngine ( )

inline

Set the format engine.

A format engine is a subclass of FormatEngine that outputs a Mdt::Error to its string representation.

Warning: Setting the format engine is not thread safe. It should be done before any error is committed to a backend.

Definition at line 77 of file Backend.h.

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