Photon Plugins API Documentation v5.0RC1

Public Member Functions | Properties | List of all members
Photon.Hive.Plugin.IPluginLogger Interface Reference

Interface for a logger. More...

Public Member Functions

void Debug (object message)
 Logs a debug message. More...
 
void Debug (object message, Exception exception)
 Logs a debug message with an exception. More...
 
void DebugFormat (string format, params object[] args)
 Logs a formatted debug message. More...
 
void DebugFormat (IFormatProvider provider, string format, params object[] args)
 Logs a formatted debug message. More...
 
void Error (object message)
 Logs an error message. More...
 
void Error (object message, Exception exception)
 Logs an error message with an exception. More...
 
void ErrorFormat (string format, params object[] args)
 Logs a formatted error message. More...
 
void ErrorFormat (IFormatProvider provider, string format, params object[] args)
 Logs a formatted error message. More...
 
void Fatal (object message)
 Logs a fatal message. More...
 
void Fatal (object message, Exception exception)
 Logs a fatal message with an exception. More...
 
void FatalFormat (string format, params object[] args)
 Logs a formatted fatal message. More...
 
void FatalFormat (IFormatProvider provider, string format, params object[] args)
 Logs a formatted fatal message. More...
 
void Info (object message)
 Logs an info message. More...
 
void Info (object message, Exception exception)
 Logs a info message with an exception. More...
 
void InfoFormat (string format, params object[] args)
 Logs a formatted info message. More...
 
void InfoFormat (IFormatProvider provider, string format, params object[] args)
 Logs a formatted info message. More...
 
void Warn (object message)
 Logs a warning. More...
 
void Warn (object message, Exception exception)
 Logs a warning with an exception. More...
 
void WarnFormat (string format, params object[] args)
 Logs a formatted warning. More...
 
void WarnFormat (IFormatProvider provider, string format, params object[] args)
 Logs a formatted warning. More...
 

Properties

bool IsDebugEnabled [get]
 Gets a value indicating whether debug logging level is enabled. More...
 
bool IsErrorEnabled [get]
 Gets a value indicating whether error logging level is enabled. More...
 
bool IsFatalEnabled [get]
 Gets a value indicating whether fatal logging level is enabled. More...
 
bool IsInfoEnabled [get]
 Gets a value indicating whether info logging level is enabled. More...
 
bool IsWarnEnabled [get]
 Gets a value indicating whether warn logging level is enabled. More...
 
string Name [get]
 Gets the name. More...
 

Detailed Description

Interface for a logger.

Member Function Documentation

◆ Debug() [1/2]

void Photon.Hive.Plugin.IPluginLogger.Debug ( object  message)

Logs a debug message.

Parameters
messageThe message.

◆ Debug() [2/2]

void Photon.Hive.Plugin.IPluginLogger.Debug ( object  message,
Exception  exception 
)

Logs a debug message with an exception.

Parameters
messageThe message.
exceptionThe exception.

◆ DebugFormat() [1/2]

void Photon.Hive.Plugin.IPluginLogger.DebugFormat ( IFormatProvider  provider,
string  format,
params object[]  args 
)

Logs a formatted debug message.

Parameters
providerThe provider.
formatThe formatted string.
argsThe args.

◆ DebugFormat() [2/2]

void Photon.Hive.Plugin.IPluginLogger.DebugFormat ( string  format,
params object[]  args 
)

Logs a formatted debug message.

Parameters
formatThe formatted string.
argsThe args.

◆ Error() [1/2]

void Photon.Hive.Plugin.IPluginLogger.Error ( object  message)

Logs an error message.

Parameters
messageThe message.

◆ Error() [2/2]

void Photon.Hive.Plugin.IPluginLogger.Error ( object  message,
Exception  exception 
)

Logs an error message with an exception.

Parameters
messageThe message.
exceptionThe exception.

◆ ErrorFormat() [1/2]

void Photon.Hive.Plugin.IPluginLogger.ErrorFormat ( IFormatProvider  provider,
string  format,
params object[]  args 
)

Logs a formatted error message.

Parameters
providerThe provider.
formatThe formatted string.
argsThe args.

◆ ErrorFormat() [2/2]

void Photon.Hive.Plugin.IPluginLogger.ErrorFormat ( string  format,
params object[]  args 
)

Logs a formatted error message.

Parameters
formatThe formatted string.
argsThe args.

◆ Fatal() [1/2]

void Photon.Hive.Plugin.IPluginLogger.Fatal ( object  message)

Logs a fatal message.

Parameters
messageThe message.

◆ Fatal() [2/2]

void Photon.Hive.Plugin.IPluginLogger.Fatal ( object  message,
Exception  exception 
)

Logs a fatal message with an exception.

Parameters
messageThe message.
exceptionThe exception.

◆ FatalFormat() [1/2]

void Photon.Hive.Plugin.IPluginLogger.FatalFormat ( IFormatProvider  provider,
string  format,
params object[]  args 
)

Logs a formatted fatal message.

Parameters
providerThe provider.
formatThe formatted string.
argsThe args.

◆ FatalFormat() [2/2]

void Photon.Hive.Plugin.IPluginLogger.FatalFormat ( string  format,
params object[]  args 
)

Logs a formatted fatal message.

Parameters
formatThe formatted string.
argsThe args.

◆ Info() [1/2]

void Photon.Hive.Plugin.IPluginLogger.Info ( object  message)

Logs an info message.

Parameters
messageThe message.

◆ Info() [2/2]

void Photon.Hive.Plugin.IPluginLogger.Info ( object  message,
Exception  exception 
)

Logs a info message with an exception.

Parameters
messageThe message.
exceptionThe exception.

◆ InfoFormat() [1/2]

void Photon.Hive.Plugin.IPluginLogger.InfoFormat ( IFormatProvider  provider,
string  format,
params object[]  args 
)

Logs a formatted info message.

Parameters
providerThe provider.
formatThe formatted string.
argsThe args.

◆ InfoFormat() [2/2]

void Photon.Hive.Plugin.IPluginLogger.InfoFormat ( string  format,
params object[]  args 
)

Logs a formatted info message.

Parameters
formatThe formatted string.
argsThe args.

◆ Warn() [1/2]

void Photon.Hive.Plugin.IPluginLogger.Warn ( object  message)

Logs a warning.

Parameters
messageThe message.

◆ Warn() [2/2]

void Photon.Hive.Plugin.IPluginLogger.Warn ( object  message,
Exception  exception 
)

Logs a warning with an exception.

Parameters
messageThe message.
exceptionThe exception.

◆ WarnFormat() [1/2]

void Photon.Hive.Plugin.IPluginLogger.WarnFormat ( IFormatProvider  provider,
string  format,
params object[]  args 
)

Logs a formatted warning.

Parameters
providerThe provider.
formatThe formatted string.
argsThe args.

◆ WarnFormat() [2/2]

void Photon.Hive.Plugin.IPluginLogger.WarnFormat ( string  format,
params object[]  args 
)

Logs a formatted warning.

Parameters
formatThe formatted string.
argsThe args.

Property Documentation

◆ IsDebugEnabled

bool Photon.Hive.Plugin.IPluginLogger.IsDebugEnabled
get

Gets a value indicating whether debug logging level is enabled.

◆ IsErrorEnabled

bool Photon.Hive.Plugin.IPluginLogger.IsErrorEnabled
get

Gets a value indicating whether error logging level is enabled.

◆ IsFatalEnabled

bool Photon.Hive.Plugin.IPluginLogger.IsFatalEnabled
get

Gets a value indicating whether fatal logging level is enabled.

◆ IsInfoEnabled

bool Photon.Hive.Plugin.IPluginLogger.IsInfoEnabled
get

Gets a value indicating whether info logging level is enabled.

◆ IsWarnEnabled

bool Photon.Hive.Plugin.IPluginLogger.IsWarnEnabled
get

Gets a value indicating whether warn logging level is enabled.

◆ Name

string Photon.Hive.Plugin.IPluginLogger.Name
get

Gets the name.