ILogger

Description

[ShutdownSurvive]
interface Tinman.Core.Logging.ILogger

Base interface for classes that are used for categorized logging.

Public / Methods

Is​Enabled


public method IsEnabled → (1)

verbosity in : 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 in : LogVerbosity

The log message verbosity.

message in : string

The log message to emit.

Emits a log messages of the given verbosity.

Message​At


public method MessageAt → (1)

idx in : int32

[0..ILogger.MessageCount-1]
The message template index.

returns → ILogMessage

The log message template.

Returns the idx in-th well-known log message template.

Message​Prepare


public method MessagePrepare → (3)

name in : 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

Category


public attribute Category → (get)

value : ILoggerCategory

[not-null]
The logger category.

The category of this logger.

Full​Name


public attribute FullName → (get)

value : string

[not-null]
The full name.

Returns the full name of this logger.

Message​Count


public attribute MessageCount → (get)

value : int32

[>=0]
The number of message templates.

Returns the number of well-known log message templates.

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 in : string

The log message to emit.

Emits a log messages of verbosity LogVerbosity.Common.

Debug


public static method Debug → (1)

message in : string

The log message to emit.

Emits a log messages of verbosity LogVerbosity.Debug.

Error

4 overloads


public static method Error1 → (1)

message in : string

The log message to emit.

Emits a log messages of verbosity LogVerbosity.Error.


public static method Error2 → (1)

error in : TinmanError

The error object.

Emits a log messages of verbosity LogVerbosity.Error.

See also

TinmanError.From


public static method Error3 → (1)

exception in : TinmanException

The exception that has caused the error.

Emits a log messages of verbosity LogVerbosity.Error.

See also

TinmanError.From


public static method Error4 → (2)

source in : string

The error source tag.

exception in : 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 in : string

The log message to emit.

Emits a log messages of verbosity LogVerbosity.Fatal.

Info


public static method Info → (1)

message in : string

The log message to emit.

Emits a log messages of verbosity LogVerbosity.Info.

Is​Common​Enabled


public static method IsCommonEnabled → ()

returns → bool

true if the log verbosity is enabled, false if it is disabled.

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

Is​Debug​Enabled


public static method IsDebugEnabled → ()

returns → bool

true if the log verbosity is enabled, false if it is disabled.

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

Is​Error​Enabled


public static method IsErrorEnabled → ()

returns → bool

true if the log verbosity is enabled, false if it is disabled.

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

Is​Fatal​Enabled


public static method IsFatalEnabled → ()

returns → bool

true if the log verbosity is enabled, false if it is disabled.

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

Is​Info​Enabled


public static method IsInfoEnabled → ()

returns → bool

true if the log verbosity is enabled, false if it is disabled.

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

Is​Trace​Enabled


public static method IsTraceEnabled → ()

returns → bool

true if the log verbosity is enabled, false if it is disabled.

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

Is​Warning​Enabled


public static method IsWarningEnabled → ()

returns → bool

true if the log verbosity is enabled, false if it is disabled.

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

Trace


public static method Trace → (1)

message in : string

The log message to emit.

Emits a log messages of verbosity LogVerbosity.Trace.

Warning

4 overloads


public static method Warning1 → (1)

message in : string

The log message to emit.

Emits a log messages of verbosity LogVerbosity.Warning.


public static method Warning2 → (1)

error in : TinmanError

The error object that has caused the warning.

Emits a log messages of verbosity LogVerbosity.Warning.

See also

TinmanError.From


public static method Warning3 → (1)

exception in : TinmanException

The exception that has caused the warning.

Emits a log messages of verbosity LogVerbosity.Warning.

See also

TinmanError.From


public static method Warning4 → (2)

source in : string

The error source tag.

exception in : Exception

The exception that has caused the warning.

Emits a log messages of verbosity LogVerbosity.Warning.

See also

TinmanError.From