A Helper class for simple and structured logging. More...

#include <logger.h>

Inheritance diagram for QtDataSync::Logger:

Public Member Functions
const QLoggingCategory &	loggingCategory () const
	Returns the logging category this logger logs to. More...

Q_NORETURN void	reportFatalError (const QString &error, const char file, int line, const char function)
	report a fatal error to the datasync engine More...

Q_NORETURN void	reportFatalError (const char error, const char file, int line, const char *function)
	report a fatal error to the datasync engine More...

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

virtual void *	qt_metacast (const char *)

virtual int	qt_metacall (QMetaObject::Call, int, void **)

	QObject (QObject *parent)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

Additional Inherited Members
Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Properties inherited from QObject
	objectName

Detailed Description

A Helper class for simple and structured logging.

Note: Do not use this class and it's methods directly. Instead, make use of the macros defined in the header

The macros behave just like their qDebug equivalents. The macros are:

logDebug
logInfo
logWarning
logCritical
logFatal (special case, read the Logger::reportFatalError documentation)

To use this macros, you must define the QTDATASYNC_LOG macro to a pointer to a logger instance. The recommended way is do this is to define the macro in your sourcefile to the logger member:

#include <QtDataSync/Logger>
#define QTDATASYNC_LOG this->logger
//...
void MyClass::initialize(Defaults *defaults)
{
    this->logger = defaults->createLogger("myclass", this);
    //...
    logDebug() << "It is working";
}

See also: Defaults::createLogger

Definition at line 14 of file logger.h.

Member Function Documentation

◆ loggingCategory()

QtDataSync::Logger::loggingCategory ( ) const

Returns the logging category this logger logs to.

Returns: The logging category (constant reference)

The category will have the format qtdatasync.<setupName>.<subCategory>, with both beeing the the constructor parameters. When using Defaults::createLogger, the setup name is taken from the defaults.

See also: logDebug, logInfo, logWarning, logCritical, logFatal

◆ reportFatalError() [1/2]

QtDataSync::Logger::reportFatalError	(	const QString &	error,
		const char *	file,
		int	line,
		const char *	function
	)

report a fatal error to the datasync engine

Parameters

error	A string describing what went wrong
file	The file where the error happend
line	The line in the file where the error happend
function	The function in where the error happend

Returns: This method does not return!

When using logFatal, this method is used to report the error. It is first printed out, using logCritical, and then the Setup::fatalErrorHandler is called to react to the error. The default error handler implementation will abort the application using std::abort

A custom handler can be set via the Setup

See also: Setup::fatalErrorHandler, logFatal

◆ reportFatalError() [2/2]

Q_NORETURN void QtDataSync::Logger::reportFatalError	(	const char *	error,
		const char *	file,
		int	line,
		const char *	function
	)