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

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

Public Member Functions

 SessionSettings (SettingAssignController *controller=NULL)
 
 SessionSettings (const SessionSettings &other)
 
 ~SessionSettings ()
 
JoinRecoveryOptions::Enum joinRecovery () const
 
void joinRecovery (JoinRecoveryOptions::Enum recovery)
 
GapAndErrorHandlingOptions::Enum gapAndErrorHandling () const
 
void gapAndErrorHandling (GapAndErrorHandlingOptions::Enum handling)
 
InstrumentRecoveryOptions::Enum instrumentRecovery () const
 
void instrumentRecovery (InstrumentRecoveryOptions::Enum recovery)
 
MarketRecoveryOptions::Enum marketRecovery () const
 
void marketRecovery (MarketRecoveryOptions::Enum recovery)
 
SessionSettingsoperator= (const SessionSettings &other)
 
- Public Member Functions inherited from SettingGroup
 SettingGroup (SettingAssignController *controller=NULL)
 
 ~SettingGroup ()
 
template<class Assignee , class Value >
void controlAssignment (const Char *description, Assignee &assignee, Value value) const
 
template<class Assignee , class Value , class AssignRoutine >
void controlAssignment (const Char *description, AssignRoutine routine, Assignee &assignee, const Value &value) 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.

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

Definition at line 440 of file SessionSettings.h.

Constructor & Destructor Documentation

SessionSettings ( SettingAssignController controller = NULL)
inline

Initializes parameters with default values.

Definition at line 479 of file SessionSettings.h.

SessionSettings ( const SessionSettings other)
inline

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

Definition at line 500 of file SessionSettings.h.

~SessionSettings ( )
inline

Cleans everything up.

Definition at line 515 of file SessionSettings.h.

Member Function Documentation

void assignNoControl ( const SessionSettings other)
inlineprotected

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

Definition at line 461 of file SessionSettings.h.

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 551 of file SessionSettings.h.

void gapAndErrorHandling ( GapAndErrorHandlingOptions::Enum  handling)
inline

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

Definition at line 559 of file SessionSettings.h.

const SettingGroup& group ( ) const
inlineprotected

Instance of the group to which the given settings belongs.

Definition at line 453 of file SessionSettings.h.

InstrumentRecoveryOptions::Enum instrumentRecovery ( ) const
inline

Indicates how instrument definitions are recovered.

Note
Default value is InstrumentRecoveryOptions::Accurate.

Definition at line 575 of file SessionSettings.h.

void instrumentRecovery ( InstrumentRecoveryOptions::Enum  recovery)
inline

Defines how instrument definitions are recovered.

Definition at line 582 of file SessionSettings.h.

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 525 of file SessionSettings.h.

void joinRecovery ( JoinRecoveryOptions::Enum  recovery)
inline

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

Definition at line 533 of file SessionSettings.h.

MarketRecoveryOptions::Enum marketRecovery ( ) const
inline

Defines selected market recovery options.

Note
Default value is MarketRecovery::BothMboAndMbp.

Definition at line 598 of file SessionSettings.h.

void marketRecovery ( MarketRecoveryOptions::Enum  recovery)
inline

Defines market recovery options.

Definition at line 605 of file SessionSettings.h.

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 622 of file SessionSettings.h.


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