OnixS C++ CME Market Data Handler  5.7.0
API documentation
SessionSettings Class Reference

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

Public Member Functions

 SessionSettings (SettingChangeController *controller=NULL)
 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)
SessionSettingsoperator= (const SessionSettings &other)
- Public Member Functions inherited from SettingGroup
 SettingGroup (SettingChangeController *controller=NULL)
 ~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)

Additional Inherited Members

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

Detailed Description

Basic set of parameters affecting behavior of the Handler when the market data processing is performed.

The given class exists to provide backward compatibility with the previous releases. Use 'AdvancedSessionSettings' instead.

Definition at line 446 of file SessionSettings.h.

Constructor & Destructor Documentation

SessionSettings ( SettingChangeController controller = NULL)

Initializes parameters with default values.

Definition at line 485 of file SessionSettings.h.

SessionSettings ( const SessionSettings other)

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

Definition at line 506 of file SessionSettings.h.

~SessionSettings ( )

Cleans everything up.

Definition at line 521 of file SessionSettings.h.

Member Function Documentation

void assignNoControl ( const SessionSettings other)

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

Definition at line 467 of file SessionSettings.h.

GapAndErrorHandlingOptions::Enum gapAndErrorHandling ( ) const

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

Default value is GapAndErrorHandling::RecoverMarketState.

Definition at line 559 of file SessionSettings.h.

SessionSettings& gapAndErrorHandling ( GapAndErrorHandlingOptions::Enum  handling)

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

Definition at line 567 of file SessionSettings.h.

const SettingGroup& group ( ) const

Instance of the group to which the given settings belongs.

Definition at line 459 of file SessionSettings.h.

InstrumentRecoveryOptions::Enum instrumentRecovery ( ) const

Indicates how instrument definitions are recovered.

Default value is InstrumentRecoveryOptions::Accurate.

Definition at line 585 of file SessionSettings.h.

SessionSettings& instrumentRecovery ( InstrumentRecoveryOptions::Enum  recovery)

Defines how instrument definitions are recovered.

Definition at line 592 of file SessionSettings.h.

JoinRecoveryOptions::Enum joinRecovery ( ) const

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

Default value is JoinRecovery::InstrumentsAndMarket.

Definition at line 531 of file SessionSettings.h.

SessionSettings& joinRecovery ( JoinRecoveryOptions::Enum  recovery)

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

Definition at line 539 of file SessionSettings.h.

MarketRecoveryOptions::Enum marketRecovery ( ) const

Defines selected market recovery options.

Default value is MarketRecovery::BothMboAndMbp.

Definition at line 610 of file SessionSettings.h.

SessionSettings& marketRecovery ( MarketRecoveryOptions::Enum  recovery)

Defines market recovery options.

Definition at line 617 of file SessionSettings.h.

SessionSettings& operator= ( const SessionSettings other)

Copies settings from the given instance.

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

Definition at line 636 of file SessionSettings.h.

The documentation for this class was generated from the following file: