ts::tlv::Logger Class Reference

A logger class for TLV messages. More...

#include <tstlvLogger.h>

Inheritance diagram for ts::tlv::Logger:

Collaboration diagram for ts::tlv::Logger:

Public Member Functions
	Logger (Report *report, int default_level=Severity::Info)
	Constructor.
	Logger (ReporterBase *delegate, int default_level=Severity::Info)
	Constructor.
virtual	~Logger () override
	Destructor.
int	defaultSeverity () const
	Get the default severity level for message logging.
void	log (const Message &msg, const UString &comment=UString()) const
	Report a TLV message.
bool	muteReport (bool mute)
	Temporarily mute the associated report.
virtual Report &	report () const override
	Access the Report which is associated with this object.
void	resetSeverities (int default_level=Severity::Info)
	Reset all severities.
void	setDefaultSeverity (int level)
	Set the default severity level for message logging.
Report *	setReport (Report *report)
	Associate this object with another Report to log errors.
ReporterBase *	setReport (ReporterBase *delegate)
	Associate this object with another ReporterBase to log errors.
void	setSeverity (TAG tag, int level)
	Set the severity level for one specific message tag.
int	severity (TAG tag) const
	Get the severity level for one specific message tag.

Static Public Member Functions
static int	SilentLevel (bool silent, int default_severity=Severity::Error)
	Compute a log severity level from a "silent" parameter.

Detailed Description

A logger class for TLV messages.

This class encapsulates a logging and debug facility for TLV messages. All messages are logged on a Report object under specific conditions. Each message, based on its tag, is logged with a specific severity. Depending on its maximum severity, the report will display or not each message.

Constructor & Destructor Documentation

Logger() [1/2]

ts::tlv::Logger::Logger ( Report *  report, int  default_level = Severity::Info  )

explicit

Constructor.

Parameters

[in]	report	Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.
[in]	default_level	Default logging level of messages.

Logger() [2/2]

ts::tlv::Logger::Logger ( ReporterBase *  delegate, int  default_level = Severity::Info  )

explicit

Constructor.

Parameters

[in]	delegate	Use the report of another ReporterBase. If delegate is null, log messages are discarded.
[in]	default_level	Default logging level of messages.

Member Function Documentation

setDefaultSeverity()

void ts::tlv::Logger::setDefaultSeverity ( int  level )

inline

Set the default severity level for message logging.

This level applies to messages without a specific log level.

Parameters

[in]

level

Default logging level of messages.

defaultSeverity()

int ts::tlv::Logger::defaultSeverity ( ) const

inline

Get the default severity level for message logging.

This level applies to messages without a specific log level.

Returns

The default severity level.

setSeverity()

void ts::tlv::Logger::setSeverity ( TAG  tag, int  level  )

inline

Set the severity level for one specific message tag.

Parameters

[in]	tag	Message tag.
[in]	level	Logging level for messages using tag.

severity()

int ts::tlv::Logger::severity

(

TAG

tag

)

const

Get the severity level for one specific message tag.

Parameters

[in]

tag

Message tag.

Returns

The severity level.

resetSeverities()

void ts::tlv::Logger::resetSeverities

(

int

default_level = Severity::Info

)

Reset all severities.

Parameters

[in]

default_level

Default logging level of messages.

log()

void ts::tlv::Logger::log	(	const Message &	msg,
		const UString &	comment = UString()
	)		const

Report a TLV message.

Parameters

[in]	msg	The message to log.
[in]	comment	Optional leading comment line (before the message).

report()

virtual Report & ts::ReporterBase::report ( ) const

overridevirtualinherited

Access the Report which is associated with this object.

Can be called from another thread only if the Report object is thread-safe.

Returns

A reference to the associated report.

Implements ts::ReporterInterface.

setReport() [1/2]

Report * ts::ReporterBase::setReport ( Report *  report )

inherited

Associate this object with another Report to log errors.

Parameters

[in]

report

Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.

Returns

The address of the previous Report object or a null pointer if there was none.

setReport() [2/2]

ReporterBase * ts::ReporterBase::setReport ( ReporterBase *  delegate )

inherited

Associate this object with another ReporterBase to log errors.

Parameters

[in]

delegate

Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used..

Returns

The address of the previous ReporterBase object or a null pointer if there was none.

muteReport()

bool ts::ReporterBase::muteReport ( bool  mute )

inherited

Temporarily mute the associated report.

Parameters

[in]

mute

It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false.

Returns

Previous state of the mute field.

SilentLevel()

static int ts::ReporterBase::SilentLevel ( bool  silent, int  default_severity = Severity::Error  )

inlinestaticinherited

Compute a log severity level from a "silent" parameter.

Some subclass methods have a "silent" parameter to avoid reporting errors which may be insignificant, typically when closing a device after an error, in which case the close operation may produce other errors if the previous error left the device in an inconsistent state. While those errors should not be displayed as errors, we still display them at debug level.

Parameters

[in]	silent	If true, do not report errors, report debug messages instead.
[in]	default_severity	Default severity, in non-silent mode (error by default).

Returns

Error when silent is false, Debug otherwise.

---

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

• tstlvLogger.h