OnixS C++ CME MDP Premium Market Data Handler 5.11.1
Users' manual and API documentation
Loading...
Searching...
No Matches
LoggingSettings Class Reference

#include <OnixS/CME/MDH/LoggingSettings.h>

Public Member Functions

 LoggingSettings (SettingChangeController *controller=nullptr)
 LoggingSettings (const LoggingSettings &other)
Logger * logger () const
Logger & loggerOrDefault () const
LoggingSettings & logger (Logger *logger)
const DebugLoggingSettings & debug () const
DebugLoggingSettings & debug ()
LoggingSettings & operator= (const LoggingSettings &other)
Public Member Functions inherited from SettingGroup
 SettingGroup (SettingChangeController *controller=nullptr)
 ~SettingGroup ()=default
template<class Assignee, class Value>
void controlAssignment (const Messaging::Char *description, Assignee &assignee, Value value) const
template<class Changeable>
void controlChange (const Messaging::Char *description, void(Changeable::*change)(), Changeable &changeable) const
template<class Change, class Changeable, class Arg>
void controlChange (const Messaging::Char *description, Change change, Changeable &changeable, const Arg &arg) const
template<class Change, class Changeable, class Arg1, class Arg2>
void controlChange (const Messaging::Char *description, Change change, Changeable &changeable, const Arg1 &arg1, const Arg2 &arg2) const

Friends

class HandlerSettings

Additional Inherited Members

Static Public Member Functions inherited from SettingGroup
static const SettingGroup & null () noexcept

Detailed Description

The collection of settings affecting use of logging subsystem by the Handler.

Definition at line 224 of file LoggingSettings.h.

Constructor & Destructor Documentation

◆ LoggingSettings() [1/2]

LoggingSettings ( SettingChangeController * controller = nullptr)
inline

Initializes the instance with the default values.

Definition at line 228 of file LoggingSettings.h.

◆ LoggingSettings() [2/2]

LoggingSettings ( const LoggingSettings & other)
inline

Initializes as a copy of the other instance.

Definition at line 236 of file LoggingSettings.h.

Member Function Documentation

◆ debug() [1/2]

DebugLoggingSettings & debug ( )
inline

The collection of settings affecting debug-level logging.

The Handler may log a lot of data at debug level. The given collection allows to filter debug information being logged.

Definition at line 286 of file LoggingSettings.h.

◆ debug() [2/2]

const DebugLoggingSettings & debug ( ) const
inline

The collection of settings affecting debug-level logging.

The Handler may log a lot of data at debug level. The given collection allows to filter debug information being logged.

Definition at line 275 of file LoggingSettings.h.

◆ logger() [1/2]

Logger * logger ( ) const
inline

Returns the custom logger selected for the Handler.

Returns
Custom logger, or nullptr when the default logger is selected.

Definition at line 245 of file LoggingSettings.h.

◆ logger() [2/2]

LoggingSettings & logger ( Logger * logger)
inline

Selects the logger to be used by the Handler.

Parameters
loggerCustom logger, or nullptr to select the default logger.
Returns
This settings instance.
Exceptions
std::runtime_errorIf the setting belongs to a handler that is processing market data or being configured from another source.

Definition at line 262 of file LoggingSettings.h.

◆ loggerOrDefault()

Logger & loggerOrDefault ( ) const
inline

Returns the effective logger selected for the Handler.

Returns
Custom logger when configured; otherwise, the default logger.

Definition at line 252 of file LoggingSettings.h.

◆ operator=()

LoggingSettings & operator= ( const LoggingSettings & other)
inline

Re-initializes the instance as a copy of the other one.

Exceptions
std::runtime_errorIf the setting belongs to a handler that is processing market data or being configured from another source.

Definition at line 295 of file LoggingSettings.h.

◆ HandlerSettings

friend class HandlerSettings
friend

Definition at line 303 of file LoggingSettings.h.