This class provides a thread-safe log message back end for the Zuble log manager. More...

#include <ZblLogAgent.h>

Inheritance diagram for Zbl::ZblLogAgent:

Collaboration diagram for Zbl::ZblLogAgent:

[legend]

Public Slots
bool	zInit (const QString &logSource, ZTableModel *logBuffer)
	Initializes the ZblLogAgent object. This method should be called after the ZblLogAgent object has been moved to it's host thread. It should be called only once prior to calling any other methods on this object. More...

void	outputLogMessage (QVariant message)
	Outputs a log message to the log histogram buffer and/or a file and/or stdout. More...

void	setOutputParameters (QVariant logParams)
	Sets the output parameters for the log worker object. More...

Signals
void	outputParametersUpdated (QVariant logParams)

Public Member Functions
	ZblLogAgent (QObject *parent=nullptr)

Protected Member Functions
bool	createLogFile ()

void	closeLogFile ()

bool	writeFileInformation (QFile &logFile, QString creationTime, QByteArray creationZone)

void	outputTextMessage (const ZblLogMessage &msg)

void	outputJsonMessage (const ZblLogMessage &msg)

QString	formatTextMessage (const ZblLogMessage &msg)

Protected Attributes
ZblLogParams	m_logParam
	Zuble logging output parameters. More...

QFile	m_outputFile
	The log output file object. More...

QTextStream	m_outputStream
	The log output stream object. More...

ZTableModel *	m_logBuffer
	Pointer to the log manager's log record histogram buffer. More...

quint64	m_nextRecordNumber
	A running counter to generate log record numbers. More...

QString	m_appName
	Application name that will be written to log file. More...

QString	m_hostName
	Name of the host executable application. More...

QString	m_hostVersionBulid
	Build name of the host executable application. More...

QString	m_logSource
	String that will be written to the "source" field of the log file. More...

int	m_hostVersionMajor
	Major version of the host executable application. More...

int	m_hostVersionMinor
	Minor version of the host executable application. More...

int	m_hostVersionPatch
	Patch version of the host executable application. More...

bool	m_outFileActive
	true if output file object is opened and accepting data, false otherwise. More...

Friends
class	ZblLogManager

Detailed Description

This class provides a thread-safe log message back end for the Zuble log manager.

It should be created in the main thread and then moved to a background thread. This object serializes logging output by accepting log messages from all threads into a queued connection method. It discards log messages generated by it's own thread to avoid logging loops.

See also: Zbl::ZblLogManager

Definition at line 50 of file ZblLogAgent.h.

Constructor & Destructor Documentation

◆ ZblLogAgent()

Zbl::ZblLogAgent::ZblLogAgent ( QObject * parent = nullptr )

explicit

Definition at line 52 of file ZblLogAgent.cpp.

Member Function Documentation

◆ closeLogFile()

void Zbl::ZblLogAgent::closeLogFile ( )

protected

Definition at line 185 of file ZblLogAgent.cpp.

Referenced by createLogFile(), outputLogMessage(), and setOutputParameters().

◆ createLogFile()

bool Zbl::ZblLogAgent::createLogFile ( )

protected

Definition at line 103 of file ZblLogAgent.cpp.

Referenced by setOutputParameters().

◆ formatTextMessage()

QString Zbl::ZblLogAgent::formatTextMessage ( const ZblLogMessage & msg )

protected

Definition at line 336 of file ZblLogAgent.cpp.

Referenced by outputLogMessage(), and outputTextMessage().

◆ outputJsonMessage()

void Zbl::ZblLogAgent::outputJsonMessage ( const ZblLogMessage & msg )

protected

Definition at line 369 of file ZblLogAgent.cpp.

Referenced by outputLogMessage().

◆ outputLogMessage

void Zbl::ZblLogAgent::outputLogMessage ( QVariant message )

slot

Outputs a log message to the log histogram buffer and/or a file and/or stdout.

This slot should only be invoked with a Qt::QueuedConnection or Qt::BlockingQueuedConnection connection type to preserve log message serialization. Don't call this method directly.

Parameters

message A variant containing a Zbl::ZblLogMessage object

Definition at line 243 of file ZblLogAgent.cpp.

◆ outputParametersUpdated

void Zbl::ZblLogAgent::outputParametersUpdated ( QVariant logParams )

signal

Referenced by setOutputParameters().

◆ outputTextMessage()

void Zbl::ZblLogAgent::outputTextMessage ( const ZblLogMessage & msg )

protected

Definition at line 331 of file ZblLogAgent.cpp.

Referenced by outputLogMessage().

◆ setOutputParameters

void Zbl::ZblLogAgent::setOutputParameters ( QVariant logParams )

slot

Sets the output parameters for the log worker object.

This slot should only be invoked with a Qt::QueuedConnection connection type to preserve integrity of this object's state machine.

Parameters

logParams A QVariant object containing a ZblLogParams object

Definition at line 300 of file ZblLogAgent.cpp.

◆ writeFileInformation()

bool Zbl::ZblLogAgent::writeFileInformation	(	QFile &	logFile,
		QString	creationTime,
		QByteArray	creationZone
	)

protected

Definition at line 197 of file ZblLogAgent.cpp.

Referenced by createLogFile().

◆ zInit

bool Zbl::ZblLogAgent::zInit	(	const QString &	logSource,
		ZTableModel *	logBuffer
	)

slot

Initializes the ZblLogAgent object. This method should be called after the ZblLogAgent object has been moved to it's host thread. It should be called only once prior to calling any other methods on this object.

Parameters

logFileLocation	Optional path to the directory in which Zuble will create log files. Pass an empty string to use the default location: data://logs
logBuffer	A pointer to the log histogram buffer to receive log record output

Returns: true if initialization successful, false if failed

Definition at line 71 of file ZblLogAgent.cpp.

Friends And Related Function Documentation

◆ ZblLogManager

friend class ZblLogManager

friend

Definition at line 52 of file ZblLogAgent.h.

Member Data Documentation

◆ m_appName

QString Zbl::ZblLogAgent::m_appName

protected

Application name that will be written to log file.

Definition at line 167 of file ZblLogAgent.h.

Referenced by writeFileInformation(), and zInit().

◆ m_hostName

QString Zbl::ZblLogAgent::m_hostName

protected

Name of the host executable application.

Definition at line 173 of file ZblLogAgent.h.

Referenced by writeFileInformation(), and zInit().

◆ m_hostVersionBulid

QString Zbl::ZblLogAgent::m_hostVersionBulid

protected

Build name of the host executable application.

Definition at line 178 of file ZblLogAgent.h.

Referenced by writeFileInformation(), and zInit().

◆ m_hostVersionMajor

int Zbl::ZblLogAgent::m_hostVersionMajor

protected

Major version of the host executable application.

Definition at line 188 of file ZblLogAgent.h.

Referenced by writeFileInformation(), and zInit().

◆ m_hostVersionMinor

int Zbl::ZblLogAgent::m_hostVersionMinor

protected

Minor version of the host executable application.

Definition at line 193 of file ZblLogAgent.h.

Referenced by writeFileInformation(), and zInit().

◆ m_hostVersionPatch

int Zbl::ZblLogAgent::m_hostVersionPatch

protected

Patch version of the host executable application.

Definition at line 198 of file ZblLogAgent.h.

Referenced by writeFileInformation(), and zInit().

◆ m_logBuffer

ZTableModel* Zbl::ZblLogAgent::m_logBuffer

protected

Pointer to the log manager's log record histogram buffer.

Definition at line 152 of file ZblLogAgent.h.

Referenced by outputLogMessage(), and zInit().

◆ m_logParam

ZblLogParams Zbl::ZblLogAgent::m_logParam

protected

Zuble logging output parameters.

Definition at line 127 of file ZblLogAgent.h.

Referenced by createLogFile(), formatTextMessage(), outputLogMessage(), and setOutputParameters().

◆ m_logSource

QString Zbl::ZblLogAgent::m_logSource

protected

String that will be written to the "source" field of the log file.

Definition at line 183 of file ZblLogAgent.h.

Referenced by formatTextMessage(), outputJsonMessage(), outputLogMessage(), and zInit().

◆ m_nextRecordNumber

quint64 Zbl::ZblLogAgent::m_nextRecordNumber

protected

A running counter to generate log record numbers.

Log record numbers are not guaranteed to be unique or sequential once written to a log file but are highly likely to be.

Definition at line 160 of file ZblLogAgent.h.

Referenced by formatTextMessage(), outputJsonMessage(), and outputLogMessage().

◆ m_outFileActive

bool Zbl::ZblLogAgent::m_outFileActive

protected

true if output file object is opened and accepting data, false otherwise.

Definition at line 204 of file ZblLogAgent.h.

Referenced by closeLogFile(), createLogFile(), and outputLogMessage().

◆ m_outputFile

QFile Zbl::ZblLogAgent::m_outputFile

protected

The log output file object.

Definition at line 136 of file ZblLogAgent.h.

Referenced by closeLogFile(), createLogFile(), and outputJsonMessage().

◆ m_outputStream

QTextStream Zbl::ZblLogAgent::m_outputStream

protected

The log output stream object.

Definition at line 144 of file ZblLogAgent.h.

Referenced by closeLogFile(), createLogFile(), and outputTextMessage().

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

zblcore/ZblLogAgent.h
zblcore/ZblLogAgent.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ZblLogAgent()

Member Function Documentation

◆ closeLogFile()

◆ createLogFile()

◆ formatTextMessage()

◆ outputJsonMessage()

◆ outputLogMessage

◆ outputParametersUpdated

◆ outputTextMessage()

◆ setOutputParameters

◆ writeFileInformation()

◆ zInit

Friends And Related Function Documentation

◆ ZblLogManager

Member Data Documentation

◆ m_appName

◆ m_hostName

◆ m_hostVersionBulid

◆ m_hostVersionMajor

◆ m_hostVersionMinor

◆ m_hostVersionPatch

◆ m_logBuffer

◆ m_logParam

◆ m_logSource

◆ m_nextRecordNumber

◆ m_outFileActive

◆ m_outputFile

◆ m_outputStream