Class ConsoleLoggingHandler

Namespace

MonkeyLoader.Logging

Assembly

MonkeyLoader.dll

Implements an LoggingHandler that writes messages to the Console.

public sealed class ConsoleLoggingHandler : LoggingHandler

Inheritance

object

LoggingHandler

ConsoleLoggingHandler

Inherited Members

LoggingHandler.Equals(object)

LoggingHandler.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Fields

BLUE

public const string BLUE = "\u001b[94m"

Field Value

string

BOLD

public const string BOLD = "\u001b[1m"

Field Value

string

CYAN

public const string CYAN = "\u001b[96m"

Field Value

string

GRAY

public const string GRAY = "\u001b[97m"

Field Value

string

GREEN

public const string GREEN = "\u001b[92m"

Field Value

string

MAGENTA

public const string MAGENTA = "\u001b[95m"

Field Value

string

NOBOLD

public const string NOBOLD = "\u001b[22m"

Field Value

string

NOREVERSE

public const string NOREVERSE = "\u001b[27m"

Field Value

string

NORMAL

public const string NORMAL = "\u001b[39m"

Field Value

string

NOUNDERLINE

public const string NOUNDERLINE = "\u001b[24m"

Field Value

string

RED

public const string RED = "\u001b[91m"

Field Value

string

REVERSE

public const string REVERSE = "\u001b[7m"

Field Value

string

UNDERLINE

public const string UNDERLINE = "\u001b[4m"

Field Value

string

YELLOW

public const string YELLOW = "\u001b[93m"

Field Value

string

Properties

Connected

Gets whether this logging handler has somewhere to log.

public override bool Connected { get; }

Property Value

bool

Remarks

For this logger, that means that the ConsoleHost process and named pipe connection to it are is available.

ConsoleHostConnected

Gets whether this logging handler has a connection to the ConsoleHost process and named pipe stream.

public static bool ConsoleHostConnected { get; }

Property Value

bool

Instance

Gets the instance of the ConsoleLoggingHandler.

public static ConsoleLoggingHandler Instance { get; }

Property Value

ConsoleLoggingHandler

ShouldBeConnected

Whether

public static bool ShouldBeConnected { get; }

Property Value

bool

Methods

ConnectAsync(CancellationToken)

Asynchronously attempts to launch the ConsoleHost and connect to it via a named pipe until the CancellationToken is signalled.

public static Task<bool> ConnectAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The CancellationToken controlling how long attempts are made.

Returns

Task<bool>

A task that returns true if it's now connected; or otherwise, false.

Debug(Func<object>)

Logs events considered to be useful during debugging when more granular information is needed.

public override void Debug(Func<object> messageProducer)

Parameters

messageProducer Func<object>

The producer to log if possible.

Disconnect()

Kills the ConsoleHost process and disconnects the named pipe.

public static void Disconnect()

Error(Func<object>)

Logs that one or more functionalities are not working, preventing some from working correctly.

public override void Error(Func<object> messageProducer)

Parameters

messageProducer Func<object>

The producer to log if possible.

Fatal(Func<object>)

Logs that one or more key functionalities, or the whole system isn't working.

public override void Fatal(Func<object> messageProducer)

Parameters

messageProducer Func<object>

The producer to log if possible.

Flush()

Attempts to flush any not yet fully logged messages.

public override void Flush()

Info(Func<object>)

Logs that something happened, which is purely informative and can be ignored during normal use.

public override void Info(Func<object> messageProducer)

Parameters

messageProducer Func<object>

The producer to log if possible.

Log(string, string)

Writes a message prefixed with a timestamp to the Console.

public void Log(string message, string textHighlight = "\u001b[39m")

Parameters

message string

The message to write.

textHighlight string

Optional color / bold / underline codes to use for the message.

Trace(Func<object>)

Logs step by step execution of code that can be ignored during standard operation, but may be useful during extended debugging sessions.

public override void Trace(Func<object> messageProducer)

Parameters

messageProducer Func<object>

The producer to log if possible.

TryConnect()

Gives TryConnect() 10s to attempt launching the ConsoleHost and connecting the named pipe.

public static void TryConnect()

Warn(Func<object>)

Logs that unexpected behavior happened, but work is continuing and the key functionalities are operating as expected.

public override void Warn(Func<object> messageProducer)

Parameters

messageProducer Func<object>

The producer to log if possible.