Class Log
Sends log messages to custom handlers or the console. Additionally writes to Debug, an in-memory buffer and a plain text file.
Namespace: NanoByte.Common
Assembly: NanoByte.Common.dll
Syntax
public static class Log : ObjectProperties
Content
Collects all log entries from this application session.
Declaration
public static string Content { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
add_Handler(LogEntryEventHandler)
Declaration
public static void add_Handler(LogEntryEventHandler value)Parameters
| Type | Name | Description |
|---|---|---|
| LogEntryEventHandler | value |
Debug(Exception)
Writes an exception as an Debug(String).
Declaration
public static void Debug(Exception ex)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | ex |
Debug(String)
Writes information to help developers diagnose problems to the log.
Declaration
public static void Debug(string message)Parameters
| Type | Name | Description |
|---|---|---|
| String | message |
Error(Exception)
Writes an exception's message as an Error(String).
Declaration
public static void Error(Exception ex)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | ex |
Remarks
Also sends the entire exception to Debug(Exception).
Error(String)
Writes a critical error that should be attended to to the log.
Declaration
public static void Error(string message)Parameters
| Type | Name | Description |
|---|---|---|
| String | message |
Info(Exception)
Writes an exception's message as a Info(String).
Declaration
public static void Info(Exception ex)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | ex |
Remarks
Also sends the entire exception to Debug(Exception).
Info(String)
Writes nice-to-know information to the log.
Declaration
public static void Info(string message)Parameters
| Type | Name | Description |
|---|---|---|
| String | message |
remove_Handler(LogEntryEventHandler)
Declaration
public static void remove_Handler(LogEntryEventHandler value)Parameters
| Type | Name | Description |
|---|---|---|
| LogEntryEventHandler | value |
Warn(Exception)
Writes an exception's message as a Warn(String).
Declaration
public static void Warn(Exception ex)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | ex |
Remarks
Also sends the entire exception to Debug(Exception).
Warn(String)
Writes a warning that doesn't have to be acted upon immediately to the log.
Declaration
public static void Warn(string message)Parameters
| Type | Name | Description |
|---|---|---|
| String | message |
Events
Handler
Invoked when a new entry is added to the log. Only the newest (last) registered handler is invoked. Console output is used as a fallback if no handlers are registered.
Declaration
public static event LogEntryEventHandler HandlerEvent Type
| Type | Description |
|---|---|
| LogEntryEventHandler |