interface ILogMessage in Tinman.Core.Logging

Represents a log message template.

interface

ILogMessage

extends

IPleaseIncludeInBinaryThanks

Attributes

Format

Begins to format a new log message.

property	Format { get }
type	LabelFormat
value	[not-null]	The label format for the new message.

Remarks:

The log message will be output when End is called.

IsEnabled

Checks if this log message is currently enabled.

property	IsEnabled { get }
type	bool
value		true if this message is enabled, false if not.

Name

Human-readable name that describes this message template.

property	Name { get }
type	string
value	[not-empty]	The message template name.

Methods

Out

Outputs the given text as a new log message.

method	Out (string message)
params	message		The message to put into the log message labels placeholder.

Remarks:

This method assumes that the log message label has only a single placeholder, and uses the given message as its value.

PleaseIncludeInBinaryThanks

This is a no-op method that forces the compiler / linker to include this type in the resulting binary.

method	PleaseIncludeInBinaryThanks ()
inherited	IPleaseIncludeInBinaryThanks.PleaseIncludeInBinaryThanks

Remarks:

Calling this stub method makes sure that all lazy constructor calls have been made.

To initialize everything, an application needs to call this method on its root module(s) (see TinmanModule), followed by a call to PleaseIncludeInBinaryThanksAll.