Abstract interface for event reporting and monitoring. More...

#include <tsReport.h>

Inheritance diagram for ts::Report:

[legend]

Public Member Functions
	Report (int max_severity=Severity::Info)
	Constructor.

virtual	~Report ()
	Destructor.

bool	debug () const
	Check if debugging is active.

void	debug (const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report a debug message with a printf-like interface.

void	debug (const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report a debug message with a printf-like interface.

void	debug (const UString &msg)
	Report a debug message.

void	error (const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report an error message with a printf-like interface.

void	error (const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report an error message with a printf-like interface.

void	error (const UString &msg)
	Report an error message.

void	fatal (const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report a fatal error message with a printf-like interface.

void	fatal (const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report a fatal error message with a printf-like interface.

void	fatal (const UString &msg)
	Report a fatal error message.

bool	gotErrors () const
	Check if errors (or worse) were reported through this object.

void	info (const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report an informational message with a printf-like interface.

void	info (const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report an informational message with a printf-like interface.

void	info (const UString &msg)
	Report an informational message.

virtual void	log (int severity, const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report a message with an explicit severity and a printf-like interface.

virtual void	log (int severity, const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report a message with an explicit severity and a printf-like interface.

virtual void	log (int severity, const UString &msg)
	Report a message with an explicit severity.

int	maxSeverity () const
	Get maximum severity level.

virtual void	raiseMaxSeverity (int level)
	Raise maximum severity level.

void	resetErrors ()
	Reset the error indicator.

virtual void	setMaxSeverity (int level)
	Set maximum severity level.

void	severe (const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report a severe error message with a printf-like interface.

void	severe (const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report a severe error message with a printf-like interface.

void	severe (const UString &msg)
	Report a severe error message.

bool	verbose () const
	Check if verbose reporting is active.

void	verbose (const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report a verbose message with a printf-like interface.

void	verbose (const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report a verbose message with a printf-like interface.

void	verbose (const UString &msg)
	Report a verbose message.

void	warning (const UChar *fmt, std::initializer_list< ArgMixIn > args)
	Report a warning message with a printf-like interface.

void	warning (const UString &fmt, std::initializer_list< ArgMixIn > args)
	Report a warning message with a printf-like interface.

void	warning (const UString &msg)
	Report a warning message.

Protected Member Functions
virtual void	writeLog (int severity, const UString &msg)=0
	Actual message reporting method.

Protected Attributes
volatile int	_max_severity = Severity::Info
	Debug level is accessible to subclasses.

Detailed Description

Abstract interface for event reporting and monitoring.

Constructor & Destructor Documentation

◆ Report()

ts::Report::Report ( int max_severity = Severity::Info )

inline

Constructor.

The default initial report level is Info.

Parameters

[in] max_severity Initial maximum severity of reported messages.

Member Function Documentation

◆ setMaxSeverity()

virtual void ts::Report::setMaxSeverity ( int level )

virtual

Set maximum severity level.

Messages with higher severities are not reported.

Parameters

[in] level Set report to that level.

Reimplemented in ts::ReportWithPrefix.

◆ raiseMaxSeverity()

virtual void ts::Report::raiseMaxSeverity ( int level )

virtual

Raise maximum severity level.

Parameters

[in] level Set report at least to that level.

Reimplemented in ts::Args.

◆ maxSeverity()

int ts::Report::maxSeverity ( ) const

inline

Get maximum severity level.

Returns: Current maximum debug level.

◆ debug() [1/4]

bool ts::Report::debug ( ) const

inline

Check if debugging is active.

Returns: True if current reporting level is Debug or higher.

◆ verbose() [1/4]

bool ts::Report::verbose ( ) const

inline

Check if verbose reporting is active.

Returns: True if current reporting level is Verbose or higher.

◆ log() [1/3]

virtual void ts::Report::log	(	int	severity,
		const UString &	msg
	)

virtual

Report a message with an explicit severity.

This method is the central reporting point. If filters the severity and drops the message if severity is higher than maxSeverity().

Subclasses should override writeLog() to implement a specific reporting device. It is not necessary to override log() unless the subclass needs to implement a different severity filtering policy.

Parameters

[in]	severity	Message severity.
[in]	msg	Message text.

◆ log() [2/3]

virtual void ts::Report::log	(	int	severity,
		const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

virtual

Report a message with an explicit severity and a printf-like interface.

Parameters

[in]	severity	Message severity.
[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ log() [3/3]

virtual void ts::Report::log	(	int	severity,
		const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

virtual

Report a message with an explicit severity and a printf-like interface.

Parameters

[in]	severity	Message severity.
[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ fatal() [1/3]

void ts::Report::fatal ( const UString & msg )

inline

Report a fatal error message.

Parameters

[in] msg Message text.

◆ fatal() [2/3]

void ts::Report::fatal	(	const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a fatal error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ fatal() [3/3]

void ts::Report::fatal	(	const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a fatal error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ severe() [1/3]

void ts::Report::severe ( const UString & msg )

inline

Report a severe error message.

Parameters

[in] msg Message text.

◆ severe() [2/3]

void ts::Report::severe	(	const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a severe error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ severe() [3/3]

void ts::Report::severe	(	const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a severe error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ error() [1/3]

void ts::Report::error ( const UString & msg )

inline

Report an error message.

Parameters

[in] msg Message text.

◆ error() [2/3]

void ts::Report::error	(	const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report an error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ error() [3/3]

void ts::Report::error	(	const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report an error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ warning() [1/3]

void ts::Report::warning ( const UString & msg )

inline

Report a warning message.

Parameters

[in] msg Message text.

◆ warning() [2/3]

void ts::Report::warning	(	const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a warning message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ warning() [3/3]

void ts::Report::warning	(	const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a warning message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ info() [1/3]

void ts::Report::info ( const UString & msg )

inline

Report an informational message.

Parameters

[in] msg Message text.

◆ info() [2/3]

void ts::Report::info	(	const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report an informational message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ info() [3/3]

void ts::Report::info	(	const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report an informational message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ verbose() [2/4]

void ts::Report::verbose ( const UString & msg )

inline

Report a verbose message.

Parameters

[in] msg Message text.

◆ verbose() [3/4]

void ts::Report::verbose	(	const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a verbose message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ verbose() [4/4]

void ts::Report::verbose	(	const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a verbose message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ debug() [2/4]

void ts::Report::debug ( const UString & msg )

inline

Report a debug message.

Parameters

[in] msg Message text.

◆ debug() [3/4]

void ts::Report::debug	(	const UChar *	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a debug message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ debug() [4/4]

void ts::Report::debug	(	const UString &	fmt,
		std::initializer_list< ArgMixIn >	args
	)

inline

Report a debug message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ gotErrors()

bool ts::Report::gotErrors ( ) const

inline

Check if errors (or worse) were reported through this object.

Returns: True if errors (or worse) were reported through this object.

◆ resetErrors()

void ts::Report::resetErrors ( )

inline

Reset the error indicator.

See also: gotErrors()

◆ writeLog()

virtual void ts::Report::writeLog	(	int	severity,
		const UString &	msg
	)

protectedpure virtual

Actual message reporting method.

Must be implemented in actual classes. The method is called only when a message passed the severity filter. It is not necessary to recheck severity inside the method.

Parameters

[in]	severity	Message severity.
[in]	msg	Message text.

Implemented in ts::Args, ts::ReportBuffer< MUTEX >, ts::ReportFile< MUTEX >, ts::Plugin, ts::TelnetConnection, ts::CerrReport, ts::NullReport, ts::ReportWithPrefix, ts::SwitchableReport, and ts::PluginThread.

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

tsReport.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Report()

Member Function Documentation

◆ setMaxSeverity()

◆ raiseMaxSeverity()

◆ maxSeverity()

◆ debug() [1/4]

◆ verbose() [1/4]

◆ log() [1/3]

◆ log() [2/3]

◆ log() [3/3]

◆ fatal() [1/3]

◆ fatal() [2/3]

◆ fatal() [3/3]

◆ severe() [1/3]

◆ severe() [2/3]

◆ severe() [3/3]

◆ error() [1/3]

◆ error() [2/3]

◆ error() [3/3]

◆ warning() [1/3]

◆ warning() [2/3]

◆ warning() [3/3]

◆ info() [1/3]

◆ info() [2/3]

◆ info() [3/3]

◆ verbose() [2/4]

◆ verbose() [3/4]

◆ verbose() [4/4]

◆ debug() [2/4]

◆ debug() [3/4]

◆ debug() [4/4]

◆ gotErrors()

◆ resetErrors()

◆ writeLog()