Class LoggingAdapterBase

This class represents the base logging adapter implementation used to log events within the system.

Inheritance
object
LoggingAdapterBase
BusLogging
Implements
Inherited Members
Namespace: Akka.Event
Assembly: Akka.dll
Syntax
public abstract class LoggingAdapterBase : ILoggingAdapter

Constructors

| Edit this page View Source

LoggingAdapterBase(ILogMessageFormatter)

Creates an instance of the LoggingAdapterBase.

Declaration
protected LoggingAdapterBase(ILogMessageFormatter logMessageFormatter)
Parameters
Type Name Description
ILogMessageFormatter logMessageFormatter

The log message formatter used by this logging adapter.
Exceptions
Type Condition
ArgumentNullException

This exception is thrown when the given logMessageFormatter is undefined.

Properties

| Edit this page View Source

Formatter

The ILogMessageFormatter used to format log messages.

Declaration
public ILogMessageFormatter Formatter { get; }
Property Value
Type Description
ILogMessageFormatter
| Edit this page View Source

IsDebugEnabled

Check to determine whether the DebugLevel is enabled.

Declaration
public abstract bool IsDebugEnabled { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsErrorEnabled

Check to determine whether the ErrorLevel is enabled.

Declaration
public abstract bool IsErrorEnabled { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsInfoEnabled

Check to determine whether the InfoLevel is enabled.

Declaration
public abstract bool IsInfoEnabled { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsWarningEnabled

Check to determine whether the WarningLevel is enabled.

Declaration
public abstract bool IsWarningEnabled { get; }
Property Value
Type Description
bool

Methods

| Edit this page View Source

IsEnabled(LogLevel)

Checks the logging adapter to see if the supplied logLevel is enabled.

Declaration
public bool IsEnabled(LogLevel logLevel)
Parameters
Type Name Description
LogLevel logLevel

The log level to check if it is enabled in this logging adapter.
Returns
Type Description
bool

true if the supplied log level is enabled; otherwise false
Exceptions
Type Condition
NotSupportedException

This exception is thrown when the given logLevel is unknown.
| Edit this page View Source

Log(LogLevel, Exception, LogMessage)

Declaration
public void Log(LogLevel logLevel, Exception cause, LogMessage message)
Parameters
Type Name Description
LogLevel logLevel
Exception cause
LogMessage message
| Edit this page View Source

Log(LogLevel, Exception, string)

Logs a message with a specified level.

Declaration
public void Log(LogLevel logLevel, Exception cause, string format)
Parameters
Type Name Description
LogLevel logLevel

The level used to log the message.
Exception cause

The exception that caused this log message.
string format

The message that is being logged.
| Edit this page View Source

NotifyLog(LogLevel, object, Exception)

Notifies all subscribers that a log event occurred for a particular level.

Declaration
protected abstract void NotifyLog(LogLevel logLevel, object message, Exception cause = null)
Parameters
Type Name Description
LogLevel logLevel

The log level associated with the log event.
object message

The message related to the log event.
Exception cause

The exception that caused the log event.
Exceptions
Type Condition
NotSupportedException

This exception is thrown when the given logLevel is unknown.

Implements

Extension Methods