Joutsen Logging v0.5.0+26-g72240ac
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Static Protected Member Functions | Properties | List of all members
Joutsen.Logging.Configuration.HandlerConfig Class Referenceabstract

A configuration element for the log handler. More...

Public Member Functions

 HandlerConfig ()
 The default constructor for building handlers in code.
 
 HandlerConfig (IConfigurationSection section)
 Creates a new configuration object from the json configuration section.
 
Handler CreateHandler ()
 Creates the handler from the configuration.
 

Static Public Attributes

const string TYPE_KEY = "type"
 The key in the configuration that defines the type of the format.
 

Static Protected Member Functions

static FormatConfig CreateFormat (IConfigurationSection section)
 Creates a format config based on the type defined in the sction.
 

Properties

FilterConfig Filter [get, set]
 The configured filter fo the handler.
 

Detailed Description

A configuration element for the log handler.

Since
0.5.0

Constructor & Destructor Documentation

◆ HandlerConfig() [1/2]

Joutsen.Logging.Configuration.HandlerConfig.HandlerConfig ( )

The default constructor for building handlers in code.

◆ HandlerConfig() [2/2]

Joutsen.Logging.Configuration.HandlerConfig.HandlerConfig ( IConfigurationSection  section)

Creates a new configuration object from the json configuration section.

Parameters
sectionthe configuration section containing the values for the handler
Remarks
The configuration section needs to provide all mandatory values for the handler.

Member Function Documentation

◆ CreateFormat()

static FormatConfig Joutsen.Logging.Configuration.HandlerConfig.CreateFormat ( IConfigurationSection  section)
staticprotected

Creates a format config based on the type defined in the sction.

◆ CreateHandler()

Handler Joutsen.Logging.Configuration.HandlerConfig.CreateHandler ( )
abstract

Creates the handler from the configuration.

Member Data Documentation

◆ TYPE_KEY

const string Joutsen.Logging.Configuration.HandlerConfig.TYPE_KEY = "type"
static

The key in the configuration that defines the type of the format.

Property Documentation

◆ Filter

FilterConfig Joutsen.Logging.Configuration.HandlerConfig.Filter
getset

The configured filter fo the handler.