OnixS C++ CME MDP Premium Market Data Handler 5.9.0
API Documentation
Loading...
Searching...
No Matches
SessionSettings Class Reference

Public Member Functions

 SessionSettings (SettingChangeController *controller=nullptr)
 SessionSettings (const SessionSettings &other)
 ~SessionSettings ()
JoinRecoveryOptions::Enum joinRecovery () const
SessionSettingsjoinRecovery (JoinRecoveryOptions::Enum recovery)
GapAndErrorHandlingOptions::Enum gapAndErrorHandling () const
SessionSettingsgapAndErrorHandling (GapAndErrorHandlingOptions::Enum handling)
InstrumentRecoveryOptions::Enum instrumentRecovery () const
SessionSettingsinstrumentRecovery (InstrumentRecoveryOptions::Enum recovery)
MarketRecoveryOptions::Enum marketRecovery () const
SessionSettingsmarketRecovery (MarketRecoveryOptions::Enum recovery)
const TcpRecoverySessionSettingstcpRecovery () const
TcpRecoverySessionSettingstcpRecovery ()
SessionSettingsoperator= (const SessionSettings &other)
Public Member Functions inherited from SettingGroup
 SettingGroup (SettingChangeController *controller=nullptr)
 ~SettingGroup ()
template<class Assignee, class Value>
void controlAssignment (const Char *description, Assignee &assignee, Value value) const
template<class Changeable>
void controlChange (const Char *description, void(Changeable::*change)(), Changeable &changeable) const
template<class Change, class Changeable, class Arg>
void controlChange (const Char *description, Change change, Changeable &changeable, const Arg &arg) const
template<class Change, class Changeable, class Arg1, class Arg2>
void controlChange (const Char *description, Change change, Changeable &changeable, const Arg1 &arg1, const Arg2 &arg2) const

Protected Member Functions

const SettingGroupgroup () const
void assignNoControl (const SessionSettings &other)
void assignNoControlLegacy (const SessionSettings &other)

Friends

class HandlerSettings
struct LegacyAssigner

Additional Inherited Members

Static Public Member Functions inherited from SettingGroup
static const SettingGroupnull ()

Detailed Description

Definition at line 349 of file SessionSettings.h.

Constructor & Destructor Documentation

◆ SessionSettings() [1/2]

SessionSettings ( SettingChangeController * controller = nullptr)
inline

Initializes parameters with default values.

Definition at line 353 of file SessionSettings.h.

◆ SessionSettings() [2/2]

SessionSettings ( const SessionSettings & other)
inline

Re-initializes settings as copies of the other ones omitting group belonging.

Definition at line 365 of file SessionSettings.h.

◆ ~SessionSettings()

~SessionSettings ( )
inline

Cleans everything up.

Definition at line 376 of file SessionSettings.h.

Member Function Documentation

◆ assignNoControl()

void assignNoControl ( const SessionSettings & other)
inlineprotected

Re-initializes the instance as a copy of the other one and bypassing assignment control.

Definition at line 481 of file SessionSettings.h.

◆ assignNoControlLegacy()

void assignNoControlLegacy ( const SessionSettings & other)
inlineprotected

Definition at line 488 of file SessionSettings.h.

◆ gapAndErrorHandling() [1/2]

GapAndErrorHandlingOptions::Enum gapAndErrorHandling ( ) const
inline

Defines what Handler should do in case of gap in real-time (incremental) data.

Note
Default value is GapAndErrorHandling::RecoverMarketState.

Definition at line 402 of file SessionSettings.h.

◆ gapAndErrorHandling() [2/2]

SessionSettings & gapAndErrorHandling ( GapAndErrorHandlingOptions::Enum handling)
inline

Defines what Handler should do in case of gap in real-time (incremental) data.

Definition at line 409 of file SessionSettings.h.

◆ group()

const SettingGroup & group ( ) const
inlineprotected

Instance of the group to which the given settings belongs.

Definition at line 474 of file SessionSettings.h.

◆ instrumentRecovery() [1/2]

InstrumentRecoveryOptions::Enum instrumentRecovery ( ) const
inline

Indicates how instrument definitions are recovered.

Note
Default value is InstrumentRecoveryOptions::Accurate.

Definition at line 419 of file SessionSettings.h.

◆ instrumentRecovery() [2/2]

SessionSettings & instrumentRecovery ( InstrumentRecoveryOptions::Enum recovery)
inline

Defines how instrument definitions are recovered.

Definition at line 425 of file SessionSettings.h.

◆ joinRecovery() [1/2]

JoinRecoveryOptions::Enum joinRecovery ( ) const
inline

Defines aspects of recovery to be done at market join stage.

Note
Default value is JoinRecovery::InstrumentsAndMarket.

Definition at line 383 of file SessionSettings.h.

◆ joinRecovery() [2/2]

SessionSettings & joinRecovery ( JoinRecoveryOptions::Enum recovery)
inline

Defines aspects of recovery to be done at market join stage.

Definition at line 390 of file SessionSettings.h.

◆ marketRecovery() [1/2]

MarketRecoveryOptions::Enum marketRecovery ( ) const
inline

Defines selected market recovery options.

Note
Default value is MarketRecovery::BothMboAndMbp.

Definition at line 435 of file SessionSettings.h.

◆ marketRecovery() [2/2]

SessionSettings & marketRecovery ( MarketRecoveryOptions::Enum recovery)
inline

Defines market recovery options.

Definition at line 441 of file SessionSettings.h.

◆ operator=()

SessionSettings & operator= ( const SessionSettings & other)
inline

Copies settings from the given instance.

Attributes controlling value assignment aren't cloned and thus only settings' values are copied.

Definition at line 464 of file SessionSettings.h.

◆ tcpRecovery() [1/2]

TcpRecoverySessionSettings & tcpRecovery ( )
inline

Editable set of TCP recovery settings.

Definition at line 455 of file SessionSettings.h.

◆ tcpRecovery() [2/2]

const TcpRecoverySessionSettings & tcpRecovery ( ) const
inline

Set of TCP recovery settings.

Definition at line 449 of file SessionSettings.h.

◆ HandlerSettings

friend class HandlerSettings
friend

Definition at line 508 of file SessionSettings.h.

◆ LegacyAssigner

friend struct LegacyAssigner
friend

Definition at line 509 of file SessionSettings.h.