ILogger

Description

[ShutdownSurvive]
interface Tinman.Core.Logging.ILogger

Derived from: ILogMessageSource
IPleaseIncludeInBinaryThanks

Base interface for classes that are used for categorized logging.

Public / Methods

IsEnabled

public method IsEnabled → (1)

verbosity ⁱⁿ : LogVerbosity: The log verbosity.
returns → bool: true if the log verbosity is enabled, false if it is disabled.

Checks if the given log verbosity is enabled for this logger.

Message

public method Message → (2)

verbosity ⁱⁿ : LogVerbosity: The log message verbosity.
message ⁱⁿ : string: The log message to emit.

Emits a log messages of the given verbosity.

MessageAt

public method MessageAt → (1)

idx ⁱⁿ : int32: [0..ILogger.MessageCount-1]
The message template index.
returns → ILogMessage: The log message template.

Returns the idx ⁱⁿ-th well-known log message template.

MessagePrepare

public method MessagePrepare → (3)

name ⁱⁿ : string: [not-empty]
The human-readable name that describes the template.
verbosity ^opt : LogVerbosity = LogVerbosity.Common: The message verbosity.
label ^opt : string = null: The message label (see Label.From) or null to use Label.Any.
returns → ILogMessage: The log message template object.

Creates a new well-known log message template.

ValidatingException: If label ^opt does not conform to the Label grammar.

Public / Attributes

FullName

public attribute FullName → (get)

value : string: [not-null]
The full name.

Returns the full name of this logger.

MessageCount

public attribute MessageCount → (get)

value : int32: [>=0]
The number of message templates.

Returns the number of well-known log message templates.

See also: ILogger.MessagePrepare

Name

public attribute Name → (get)

value : string: [not-null]
The name.

Returns the name of this logger.

Extensions

Common

public static method Common → (1)

message ⁱⁿ : string: The log message to emit.

Emits a log messages of verbosity LogVerbosity.Common.

Debug

public static method Debug → (1)

message ⁱⁿ : string: The log message to emit.

Emits a log messages of verbosity LogVerbosity.Debug.

Error

_4 overloads

public static method Error¹ → (1)

message ⁱⁿ : string: The log message to emit.

Emits a log messages of verbosity LogVerbosity.Error.

public static method Error² → (1)

error ⁱⁿ : TinmanError: The error object.

Emits a log messages of verbosity LogVerbosity.Error.

See also: TinmanError.From

public static method Error³ → (1)

exception ⁱⁿ : TinmanException: The exception that has caused the error.

Emits a log messages of verbosity LogVerbosity.Error.

See also: TinmanError.From

public static method Error⁴ → (2)

source ⁱⁿ : string: The error source tag.
exception ⁱⁿ : Exception: The exception that has caused the error.

Emits a log messages of verbosity LogVerbosity.Error.

See also: TinmanError.From

Fatal

public static method Fatal → (1)

message ⁱⁿ : string: The log message to emit.

Emits a log messages of verbosity LogVerbosity.Fatal.

Info

public static method Info → (1)

message ⁱⁿ : string: The log message to emit.

Emits a log messages of verbosity LogVerbosity.Info.