interface ILoggerCategory in Tinman.Core.Logging

Base interface for classes that represent categories for ILogger objects.

interface

ILoggerCategory

extends

ILogMessageSource

Attributes

ChildCount

Returns the number of child categories.

property	ChildCount { get }
type	int32
value	[>=0]	The number of child categories.

See also:

ChildAt

FullName

Returns the full name of this category.

property	FullName { get }
type	string
value	[not-null]	The full name.

LoggerCount

Returns the number of loggers in this category.

property	LoggerCount { get }
type	int32
value	[>=0]	The number of loggers.

See also:

LoggerAt

Name

Returns the name of this category.

property	Name { get }
type	string
value	[not-null]	The name.

Parent

Returns the parent category of this category.

property	Parent { get }
type	ILoggerCategory
value		The parent category or null if this category is the root.

Severity

Sets or gets the log message severity that shall be emitted for this log message source.

property	Severity { get }
type	LogSeverity
value		The log message severity.
inherited	ILogMessageSource.Severity

Methods

AddHandler

Adds a log message handler to this log message source.

method	AddHandler ([Owner] ILogMessageHandler handler, bool replace = false)
type	ILogMessageSource
params	handler	[not-null]	The handler to add.
	replace		Replace existing handler if redundant (see remarks)?
returns		[not-null]	this
inherited	ILogMessageSource.AddHandler

Remarks:

If there already is a handler which makes the given one redundant (see IsRedundant), one of the following actions is performed:

• If replace is set to true, the existing handler is replaced with the given handler.
• if replace is set to false (which is the default), the given handler is discarded.

ChangeSeverity

Changes the log message severity of this log message source.

method	ChangeSeverity (LogSeverity severity, bool descendants = false, bool ancestors = false)
params	severity		The new log message severity.
	descendants		Also set all descendant log message sources to the given log message severity? Defaults to false.
	ancestors		Set the log message severity of all ancestor log message sources to the given log message severity if less detailed? Defaults to false.
inherited	ILogMessageSource.ChangeSeverity

ChildAt

Returns the idx-th child category.

method	ChildAt (int32 idx)
type	ILoggerCategory
params	idx	[0..ChildCount-1]	The child category index.
returns		[not-null]	The child category.

See also:

ChildCount

LoggerAt

Returns the idx-th logger in this category.

method	LoggerAt (int32 idx)
type	ILogger
params	idx	[0..LoggerCount-1]	The logger index.
returns		[not-null]	The logger object.

See also:

LoggerCount

RemoveHandler

Removes the given log message handle from this log message source.

method	RemoveHandler (ILogMessageHandler handler)
type	ILogMessageSource
params	handler	[not-null]	The handler to remove.
returns		[not-null]	this
inherited	ILogMessageSource.RemoveHandler