io.tsduck.AbstractAsyncReport Class Reference

An abstract Report class which can be derived by applications to get asynchronous log messages. More...

Inheritance diagram for io.tsduck.AbstractAsyncReport:

Collaboration diagram for io.tsduck.AbstractAsyncReport:

Public Member Functions
void	debug (String message)
	Log a messages at debug level.
native void	delete ()
	Delete the encapsulated C++ object.
void	error (String message)
	Log a messages at error level.
void	info (String message)
	Log a messages at info level.
native void	log (int severity, String message)
	Log a message to the report.
abstract void	logMessageHandler (int severity, String message)
	This method is invoked each time a message is logged.
native void	setMaxSeverity (int severity)
	Set the maximum severity of the report.
native void	terminate ()
	Synchronously terminates the asynchronous log thread.
void	verbose (String message)
	Log a messages at verbose level.
void	warning (String message)
	Log a messages at warning level.

Static Public Member Functions
static native String	header (int severity)
	Formatted line prefix header for a severity.

Static Public Attributes
static final int	Debug = 1
	First debug level.
static final int	Error = -3
	Regular error.
static final int	Fatal = -5
	Fatal error, typically aborts the application.
static final int	Info = -1
	Information message.
static final int	Severe = -4
	Severe error.
static final int	Verbose = 0
	Verbose information.
static final int	Warning = -2
	Warning message.

Protected Member Functions
	AbstractAsyncReport (int severity, boolean syncLog, int logMsgCount)
	Constructor (for subclasses).

Protected Attributes
long	nativeObject = 0
	The address of the underlying C++ object.

Detailed Description

An abstract Report class which can be derived by applications to get asynchronous log messages.

This class is functionally similar to ts::AsyncReport except that the message handling can be implemented in Java. This class is suitable for use with io.tsduck.TSProcessor.

Constructor & Destructor Documentation

AbstractAsyncReport()

io.tsduck.AbstractAsyncReport.AbstractAsyncReport ( int  severity, boolean  syncLog, int  logMsgCount  )

inlineprotected

Constructor (for subclasses).

Parameters

severity	Initial severity.
syncLog	Synchronous log.
logMsgCount	Maximum buffered log messages.

Member Function Documentation

delete()

native void io.tsduck.AbstractAsyncReport.delete

(

)

Delete the encapsulated C++ object.

Reimplemented from io.tsduck.NativeObject.

logMessageHandler()

abstract void io.tsduck.AbstractAsyncReport.logMessageHandler ( int  severity, String  message  )

abstract

This method is invoked each time a message is logged.

If a subclass wants to intercept log messages, it should override this method. Take care that this method is invoked in the context of a native thread.

Parameters

severity	Severity of the message.
message	Message line.

setMaxSeverity()

native void io.tsduck.Report.setMaxSeverity ( int  severity )

inherited

Set the maximum severity of the report.

Parameters

severity

Severity level.

log()

native void io.tsduck.Report.log ( int  severity, String  message  )

inherited

Log a message to the report.

Parameters

severity	Severity level of the message.
message	Message to report.

error()

void io.tsduck.Report.error ( String  message )

inlineinherited

Log a messages at error level.

Parameters

message

Message to report.

warning()

void io.tsduck.Report.warning ( String  message )

inlineinherited

Log a messages at warning level.

Parameters

message

Message to report.

info()

void io.tsduck.Report.info ( String  message )

inlineinherited

Log a messages at info level.

Parameters

message

Message to report.

verbose()

void io.tsduck.Report.verbose ( String  message )

inlineinherited

Log a messages at verbose level.

Parameters

message

Message to report.

debug()

void io.tsduck.Report.debug ( String  message )

inlineinherited

Log a messages at debug level.

Parameters

message

Message to report.

header()

static native String io.tsduck.Report.header ( int  severity )

staticinherited

Formatted line prefix header for a severity.

Parameters

severity

Severity value.

Returns

A string to prepend to messages. Empty for Info and Verbose levels.

Member Data Documentation

nativeObject

long io.tsduck.NativeObject.nativeObject = 0

protectedinherited

The address of the underlying C++ object.

It is normally accessed by native methods only.

---

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

• AbstractAsyncReport.java