Abstract class: RT.Util.LoggerBase

• Assembly: RT.Util.Core, Version=1.0.0.9999, Culture=neutral, PublicKeyToken=null
• Namespace: RT.Util
• Show inherited types...
  Inherits from:

  • object
• Show derived types...
  Derived types:

  • RT.Util.ConsoleLogger
  • RT.Util.FileAppendLogger
  • RT.Util.MulticastLogger
  • RT.Util.NullLogger
  • RT.Util.StreamLogger

Summary

Abstract base class for all loggers. Implements some common functionality.

Remarks

Use a lock on this object to make several consecutive logging operations atomic.

Constructors

LoggerBase()

Initialises some members to their default values.

Instance methods

void	ConfigureVerbosity(string settings) Virtual	Takes a string which encodes verbosity limit configuration, parses it and sets the limits accordingly. On failure throws an ArgumentException with a fairly detailed description of the string format. (see also remarks)
void	Debug(string message)	Appends a debug message to the log.
void	Debug(uint verbosity, string message)
void	Error(string message)	Appends an error message to the log.
void	Error(uint verbosity, string message)
void	Exception(Exception exception, LogType type = LogType.Error)	Logs an exception with a stack trace and verbosity 1.
void	Exception(Exception exception, uint verbosity, LogType type) Virtual	Logs an exception with a stack trace at the specified verbosity and message type. Any InnerExceptions are also logged as appropriate.
string	GetMessageTypeString(LogType type)	Specifies a short string describing each log type (INFO, WARN, ERROR, or DEBUG).
void	Info(string message)	Appends an informational message to the log.
void	Info(uint verbosity, string message)
bool	IsDebugOn(uint verbosity = 1)	Determines whether a debug message would be visible at specified verbosity.
bool	IsErrorOn(uint verbosity = 1)	Determines whether an error message would be visible at specified verbosity.
bool	IsInfoOn(uint verbosity = 1)	Determines whether an informational message would be visible at specified verbosity.
bool	IsLogOn(uint verbosity, LogType type) Virtual	Returns true if a message of the specified verbosity and type will actually end up being logged.
bool	IsWarnOn(uint verbosity = 1)	Determines whether a warning message would be visible at specified verbosity.
void	Log(uint verbosity, LogType type, string message) Abstract	Appends an entry to the log. Derived classes implement this to put the log data where necessary. (see also remarks)
void	Separator() Abstract	Creates a visual separation in the log, for example if a new section starts.
void	Warn(string message)	Appends a warning message to the log.
void	Warn(uint verbosity, string message)

Instance fields

string	IndentFormatSuffix	When printing multi-line (e.g. wrapped) messages, the indent text will consist of a number of spaces and end with this suffix.
string	MessageFormat	Holds a format string for the log information message. This will receive the following arguments: {0}: timestamp, {1}: message type string, {2}: message verbosity level. The actual message will be printed immediately after the log information message.
string	TimestampFormat	Holds a format string for printing the date/time at which a log entry was added. Defaults to a full ISO-formatted date/time string with milliseconds.
bool	TimestampInUTC	If true, the timestamps will be printed in UTC. Otherwise in local time. Defaults to false.
Dictionary<LogType, uint>	VerbosityLimit	Holds the current verbosity limit for each of the log types. Only messages with same or lower verbosity will be printed. Defaults to level 1 for all messages except debug, which defaults to 0. (see also remarks)