Class EventLogger

Namespace

DuetControlServer.Utility

Assembly

DuetControlServer.dll

Class for message logging

public class EventLogger

Inheritance

object

EventLogger

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EventLogger(FilePathResolver, ObjectModel, IHostApplicationLifetime, ILogger<EventLogger>, IOptions<Settings>)

Class for message logging

public EventLogger(FilePathResolver filePath, ObjectModel model, IHostApplicationLifetime lifetime, ILogger<EventLogger> logger, IOptions<Settings> settings)

Parameters

filePath FilePathResolver

File path resolver

model ObjectModel

Object model

lifetime IHostApplicationLifetime

Host application lifetime

logger ILogger<EventLogger>

Logger instance

settings IOptions<Settings>

Settings

Fields

DefaultLogFile

Default log file for M929 in case no P parameter is specified

public const string DefaultLogFile = "eventlog.txt"

Field Value

string

Methods

Log(EventLogLevel, Message)

Write a message including timestamp to the log file

public void Log(EventLogLevel level, Message message)

Parameters

level EventLogLevel

Log level of the message

message Message

Message to log

Log(EventLogLevel, MessageType, string)

Write a message including timestamp to the log file

public void Log(EventLogLevel level, MessageType type, string content)

Parameters

level EventLogLevel

Log level

type MessageType

Message type

content string

Message content

Log(Message)

Write messages including timestamp to the log file

public void Log(Message message)

Parameters

message Message

Message to log

Log(MessageType, string)

Write a message including timestamp to the log file

public void Log(MessageType type, string content)

Parameters

type MessageType

Message type

content string

Message content

LogAsync(EventLogLevel, Message)

Write a message including timestamp to the log file asynchronously

public Task LogAsync(EventLogLevel level, Message message)

Parameters

level EventLogLevel

Log level of the message

message Message

Message to log

Returns

Task

Asynchronous task

LogAsync(EventLogLevel, MessageType, string)

Write a message including timestamp to the log file asynchronously

public Task LogAsync(EventLogLevel level, MessageType type, string content)

Parameters

level EventLogLevel

Log level

type MessageType

Message type

content string

Message content

Returns

Task

Asynchronous task

LogAsync(Message)

Write messages including timestamp to the log file asynchronously

public Task LogAsync(Message message)

Parameters

message Message

Message to log

Returns

Task

Asynchronous task

LogAsync(MessageType, string)

Write a message including timestamp to the log file asynchronously

public Task LogAsync(MessageType type, string content)

Parameters

type MessageType

Message type

content string

Message content

Returns

Task

Asynchronous task

LogOutput(Message)

Log and output a message

public void LogOutput(Message message)

Parameters

message Message

Message to log and output

LogOutput(MessageType, string)

Log and output a message

public void LogOutput(MessageType type, string content)

Parameters

type MessageType

Message type

content string

Message content

LogOutputAsync(Message, CancellationToken)

Log and output a message asynchronously

public Task LogOutputAsync(Message message, CancellationToken cancellationToken = default)

Parameters

message Message

Message to log and output

cancellationToken CancellationToken

Cancellation token

Returns

Task

Asynchronous task

LogOutputAsync(MessageType, string, CancellationToken)

Log and output a message

public Task LogOutputAsync(MessageType type, string content, CancellationToken cancellationToken = default)

Parameters

type MessageType

Message type

content string

Message content

cancellationToken CancellationToken

Cancellation token

Returns

Task

Asynchronous task

Start(string, EventLogLevel)

Start logging to a file

public void Start(string filename, EventLogLevel level)

Parameters

filename string

Filename to write to

level EventLogLevel

Requested log level

StartAsync(string, EventLogLevel)

Start logging to a file

public Task StartAsync(string filename, EventLogLevel level)

Parameters

filename string

Filename to write to

level EventLogLevel

Requested log level

Returns

Task

Asynchronous task

Stop()

Stop logging

public void Stop()

StopAsync()

Stop logging asynchronously

public Task StopAsync()

Returns

Task

Asynchronous task