Volume Control
Application-specific hotkeys for Windows
Static Public Member Functions | Properties | List of all members
VolumeControl.Log.FLog Class Reference

Static file logger class. More...

Collaboration diagram for VolumeControl.Log.FLog:

Static Public Member Functions

static void Initialize (string path, bool enable, EventType logFilter, bool deleteExisting=true)
 Initializes the log. The settings object must be created before calling this method. This method can only be called once. More...
 
static void ChangeLogPath (string newPath)
 Sets the log path to a new location. More...
 
static bool FilterEventType (EventType eventType)
 
static void LogMessage (LogMessage logMessage)
 
static bool Trace (params object?[] lines)
 
static bool Trace (LogMessage logMessage)
 
static bool Debug (params object?[] lines)
 
static bool Debug (LogMessage logMessage)
 
static bool Info (params object?[] lines)
 
static bool Info (LogMessage logMessage)
 
static bool Warning (params object?[] lines)
 
static bool Warning (LogMessage logMessage)
 
static bool Error (params object?[] lines)
 
static bool Error (LogMessage logMessage)
 
static bool Fatal (params object?[] lines)
 
static bool Fatal (LogMessage logMessage)
 
static bool Critical (params object?[] lines)
 
static bool Critical (LogMessage logMessage)
 
static bool Blank (params object?[] lines)
 
static bool Blank (LogMessage logMessage)
 

Properties

static AsyncLogWriter Log [get]
 Gets the AsyncLogWriter instance. More...
 
static bool IsAsyncEnabled [get, set]
 
static bool IsInitialized [get]
 Gets whether this log has been initialized yet or not. More...
 

Detailed Description

Static file logger class.

The Initialize method must be called before accessing any properties.

Member Function Documentation

◆ ChangeLogPath()

static void VolumeControl.Log.FLog.ChangeLogPath ( string  newPath)
static

Sets the log path to a new location.

Parameters
newPathThe filepath to change the log path to.

References VolumeControl.Log.FLog.Log.

◆ Initialize()

static void VolumeControl.Log.FLog.Initialize ( string  path,
bool  enable,
EventType  logFilter,
bool  deleteExisting = true 
)
static

Initializes the log. The settings object must be created before calling this method. This method can only be called once.

Exceptions
InvalidOperationExceptionThe method has already been called before.
NotInitializedExceptionThe default config object hasn't been initialized yet.

References VolumeControl.Log.FLog.Log, and VolumeControl.Log.AsyncLogWriter.ResetEndpoint().

Here is the call graph for this function:

Property Documentation

◆ IsInitialized

bool VolumeControl.Log.FLog.IsInitialized
staticget

Gets whether this log has been initialized yet or not.

This does not throw exceptions.

◆ Log

AsyncLogWriter VolumeControl.Log.FLog.Log
staticget

Gets the AsyncLogWriter instance.

To preserve thread-safety, the FileEndpoint cannot be accessed through the log writer. It can be configured via the relevant setting in the Config.

Referenced by VolumeControl.Log.FLog.ChangeLogPath(), VolumeControl.CoreAudio.AudioDevice.Dispose(), VolumeControl.CoreAudio.AudioSession.Dispose(), VolumeControl.SDK.Internal.Initializer.Initialize(), VolumeControl.Log.FLog.Initialize(), VolumeControl.Core.Input.Actions.HotkeyActionInstance.Invoke(), and VolumeControl.Core.Input.HotkeyActionAddonLoader.LoadActions().

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