Class FileLoggingHandler

Namespace

MonkeyLoader.Logging

Assembly

MonkeyLoader.dll

Implements an LoggingHandler that writes messages to a file.

public sealed class FileLoggingHandler : LoggingHandler, IDisposable

Inheritance

object

LoggingHandler

FileLoggingHandler

Implements

IDisposable

Inherited Members

LoggingHandler.Equals(object)

LoggingHandler.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FileLoggingHandler(FileStream)

Creates a new file logging handler with the given FileStream as the target.

public FileLoggingHandler(FileStream fileStream)

Parameters

fileStream FileStream

The file to write to.

FileLoggingHandler(string)

Creates a new file logging handler with the file at the given path as the target.

public FileLoggingHandler(string path)

Parameters

path string

The file to write to.

Properties

Connected

Gets whether this logging handler has somewhere to log.

public override bool Connected { get; }

Property Value

bool

Methods

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.

Dispose()

public void Dispose()

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(Func<object>)

Writes the message from the producer, prefixed with a timestamp, to the log file.

public void Log(Func<object> messageProducer)

Parameters

messageProducer Func<object>

The producer for the message to write.

Log(string)

Writes a message prefixed with a timestamp to the log file.

public void Log(string message)

Parameters

message string

The message to write.

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.

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.