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

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

Public Member Functions

 TcpRecoverySessionSettings (const SettingGroup *group=NULL)
 
 TcpRecoverySessionSettings (const TcpRecoverySessionSettings &other)
 
 ~TcpRecoverySessionSettings ()
 
TcpRecoveryServiceservice () const
 
void service (TcpRecoveryService *service)
 
UInt32 attempts () const
 
void attempts (UInt32 qty)
 
UInt32 servingTimeLimit () const
 
void servingTimeLimit (UInt32 servingTimeLimit)
 
TcpRecoverySessionSettingsoperator= (const TcpRecoverySessionSettings &other)
 

Friends

class AdvancedSessionSettings
 

Detailed Description

Definition at line 231 of file SessionSettings.h.

Constructor & Destructor Documentation

TcpRecoverySessionSettings ( const SettingGroup group = NULL)
inline

Initializes the instance with the default values.

Optional group parameter lets to make the instance belonging to a given group of settings.

Definition at line 268 of file SessionSettings.h.

Initializes the instance as a copy of the other one. Grouping and value assignment control services are not copied.

Definition at line 284 of file SessionSettings.h.

Finalizes the instance.

Definition at line 295 of file SessionSettings.h.

Member Function Documentation

UInt32 attempts ( ) const
inline

Number of times a Handler must try to recover missing data using the TCP recovery before it switches to recover market state from snapshots or resumes incremental data processing by natural refresh.

Definition at line 333 of file SessionSettings.h.

void attempts ( UInt32  qty)
inline

Updates number of times a Handler must try to recover missing data using the TCP recovery before it switches to recover market state from snapshots or resumes incremental data processing by natural refresh.

Definition at line 344 of file SessionSettings.h.

TcpRecoverySessionSettings& operator= ( const TcpRecoverySessionSettings other)
inline

Re-initializes as a copy of the other one. Grouping and value assignment control services aren't copied.

Definition at line 392 of file SessionSettings.h.

TcpRecoveryService* service ( ) const
inline

An instance of the TCP recovery service if there's any associated.

Null instance indicates no service is associated and thus TCP recovery is disabled during market data processing session.

Definition at line 306 of file SessionSettings.h.

void service ( TcpRecoveryService service)
inline

Associates the instance of the TCP Recovery service to be used by a Handler during market data processing session.

Definition at line 315 of file SessionSettings.h.

UInt32 servingTimeLimit ( ) const
inline

Amount of time allocated to process a recovery request. TCP recovery service interrupts request processing if it can't be accomplished within given time frame.

Interval is measured in seconds.

Note
Default value is '10'.

Definition at line 365 of file SessionSettings.h.

void servingTimeLimit ( UInt32  servingTimeLimit)
inline

Amount of time allocated to process a recovery request. TCP recovery service interrupts request processing if it can't be accomplished within given time frame.

Interval is measured in seconds.

Definition at line 377 of file SessionSettings.h.

Friends And Related Function Documentation

friend class AdvancedSessionSettings
friend

Lets grouping and value assignment control functioning.

Definition at line 235 of file SessionSettings.h.


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