Represents a log writer instance. More...

Inheritance diagram for VolumeControl.Log.Interfaces.ILogWriter:

Collaboration diagram for VolumeControl.Log.Interfaces.ILogWriter:

Public Member Functions
bool	FilterEventType (EventType eventType)
	Checks if messages with the specified eventType are shown in the log. More...

bool	LogMessage (LogMessage logMessage)
	Writes the specified logMessage to the log, if its event type is enabled by the filter. More...

bool	Trace (LogMessage logMessage)
	Queues writing an EventType.TRACE log message. More...

bool	Debug (params object?[] lines)
	Queues writing an EventType.DEBUG message with the specified lines . More...

bool	Debug (LogMessage logMessage)
	Queues writing an EventType.DEBUG log message. More...

bool	Info (params object?[] lines)
	Queues writing an EventType.INFO message with the specified lines . More...

bool	Info (LogMessage logMessage)
	Queues writing an EventType.INFO log message. More...

bool	Warning (params object?[] lines)
	Queues writing an EventType.WARN message with the specified lines . More...

bool	Warning (LogMessage logMessage)
	Queues writing an EventType.WARN log message. More...

bool	Error (params object?[] lines)
	Queues writing an EventType.ERROR message with the specified lines . More...

bool	Error (LogMessage logMessage)
	Queues writing an EventType.ERROR log message. More...

bool	Fatal (params object?[] lines)
	Queues writing an EventType.FATAL message with the specified lines . More...

bool	Fatal (LogMessage logMessage)
	Queues writing an EventType.FATAL log message. More...

bool	Critical (params object?[] lines)
	Queues writing an EventType.CRITICAL message with the specified lines . More...

bool	Critical (LogMessage logMessage)
	Queues writing an EventType.CRITICAL log message. More...

bool	Blank (params object?[] lines)
	Queues writing an EventType.NONE message with the specified lines . More...

bool	Blank (LogMessage logMessage)
	Queues writing an EventType.NONE log message. More...

Detailed Description

Represents a log writer instance.

Member Function Documentation

◆ Blank() [1/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Blank ( LogMessage logMessage )

Queues writing an EventType.NONE log message.

This produces a message with no event type header, but a timestamp is still shown.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Blank() [2/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Blank ( params object?[] lines )

Queues writing an EventType.NONE message with the specified lines .

This produces a message with no event type header, but a timestamp is still shown.

Parameters

lines Any number of objects. Each object will be written on a new line. null objects and blank strings are skipped.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Critical() [1/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Critical ( LogMessage logMessage )

Queues writing an EventType.CRITICAL log message.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Critical() [2/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Critical ( params object?[] lines )

Queues writing an EventType.CRITICAL message with the specified lines .

Parameters

lines Any number of objects. Each object will be written on a new line. null objects and blank strings are skipped.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Debug() [1/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Debug ( LogMessage logMessage )

Queues writing an EventType.DEBUG log message.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Debug() [2/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Debug ( params object?[] lines )

Queues writing an EventType.DEBUG message with the specified lines .

Parameters

lines Any number of objects. Each object will be written on a new line. null objects and blank strings are skipped.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Error() [1/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Error ( LogMessage logMessage )

Queues writing an EventType.ERROR log message.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Error() [2/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Error ( params object?[] lines )

Queues writing an EventType.ERROR message with the specified lines .

Parameters

lines Any number of objects. Each object will be written on a new line. null objects and blank strings are skipped.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Fatal() [1/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Fatal ( LogMessage logMessage )

Queues writing an EventType.FATAL log message.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Fatal() [2/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Fatal ( params object?[] lines )

Queues writing an EventType.FATAL message with the specified lines .

Parameters

lines Any number of objects. Each object will be written on a new line. null objects and blank strings are skipped.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ FilterEventType()

bool VolumeControl.Log.Interfaces.ILogWriter.FilterEventType ( EventType eventType )

Checks if messages with the specified eventType are shown in the log.

Parameters

eventType An EventType to check.

Returns: true when the eventType is shown; otherwise false.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Info() [1/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Info ( LogMessage logMessage )

Queues writing an EventType.INFO log message.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Info() [2/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Info ( params object?[] lines )

Queues writing an EventType.INFO message with the specified lines .

Parameters

lines Any number of objects. Each object will be written on a new line. null objects and blank strings are skipped.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ LogMessage()

bool VolumeControl.Log.Interfaces.ILogWriter.LogMessage ( LogMessage logMessage )

Writes the specified logMessage to the log, if its event type is enabled by the filter.

When IsAsyncEnabled is true, the message is written asynchronously; otherwise, the message is written synchronously and the caller will be blocked until the message has been written.

Parameters

logMessage The message to write to the log.

Returns: true when the logMessage 's event type is enabled; otherwise, false.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Trace()

bool VolumeControl.Log.Interfaces.ILogWriter.Trace ( LogMessage logMessage )

Queues writing an EventType.TRACE log message.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Warning() [1/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Warning ( LogMessage logMessage )

Queues writing an EventType.WARN log message.

Parameters

logMessage A Log.LogMessage instance to write.

Implemented in VolumeControl.Log.AsyncLogWriter.

◆ Warning() [2/2]

bool VolumeControl.Log.Interfaces.ILogWriter.Warning ( params object?[] lines )

Queues writing an EventType.WARN message with the specified lines .

Parameters

lines Any number of objects. Each object will be written on a new line. null objects and blank strings are skipped.

Implemented in VolumeControl.Log.AsyncLogWriter.

The documentation for this interface was generated from the following file:

/home/runner/work/volume-control/volume-control/VolumeControl.Log/Interfaces/ILogWriter.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ Blank() [1/2]

◆ Blank() [2/2]

◆ Critical() [1/2]

◆ Critical() [2/2]

◆ Debug() [1/2]

◆ Debug() [2/2]

◆ Error() [1/2]

◆ Error() [2/2]

◆ Fatal() [1/2]

◆ Fatal() [2/2]

◆ FilterEventType()

◆ Info() [1/2]

◆ Info() [2/2]

◆ LogMessage()

◆ Trace()

◆ Warning() [1/2]

◆ Warning() [2/2]