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

Public Member Functions

 TcpRecoverySessionSettings (const SettingGroup *group=nullptr)
 TcpRecoverySessionSettings (const TcpRecoverySessionSettings &other)
 ~TcpRecoverySessionSettings ()
TcpRecoveryServiceservice () const
TcpRecoverySessionSettingsservice (TcpRecoveryService *service)
UInt32 attempts () const
TcpRecoverySessionSettingsattempts (UInt32 qty)
UInt32 servingTimeLimit () const
TcpRecoverySessionSettingsservingTimeLimit (UInt32 servingTimeLimit)
TcpRecoverySessionSettingsoperator= (const TcpRecoverySessionSettings &other)

Friends

class SessionSettings

Detailed Description

Definition at line 200 of file SessionSettings.h.

Constructor & Destructor Documentation

◆ TcpRecoverySessionSettings() [1/2]

TcpRecoverySessionSettings ( const SettingGroup * group = nullptr)
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 207 of file SessionSettings.h.

◆ TcpRecoverySessionSettings() [2/2]

Initializes the instance as a copy of the other one.

Grouping and value assignment control services are not copied.

Definition at line 219 of file SessionSettings.h.

◆ ~TcpRecoverySessionSettings()

Finalizes the instance.

Definition at line 228 of file SessionSettings.h.

Member Function Documentation

◆ attempts() [1/2]

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

◆ attempts() [2/2]

TcpRecoverySessionSettings & 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 266 of file SessionSettings.h.

◆ operator=()

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

◆ service() [1/2]

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

◆ service() [2/2]

TcpRecoverySessionSettings & 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 244 of file SessionSettings.h.

◆ servingTimeLimit() [1/2]

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

◆ servingTimeLimit() [2/2]

TcpRecoverySessionSettings & 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 292 of file SessionSettings.h.

◆ SessionSettings

friend class SessionSettings
friend

Lets grouping and value assignment control functioning.

Definition at line 312 of file SessionSettings.h.