OnixS C++ CME Streamlined Market Data Handler  1.1.0.5
API documentation
TcpRecoverySettings Class Reference

#include <TcpRecovery.h>

Public Member Functions

 TcpRecoverySettings ()
 
 ~TcpRecoverySettings ()
 
const std::string & username () const
 
void username (const std::string &username)
 
const std::string & password () const
 
void password (const std::string &password)
 
UInt32 reconnectAttempts () const
 
void reconnectAttempts (UInt32 reconnectAttempts)
 
UInt32 reconnectInterval () const
 
void reconnectInterval (UInt32 reconnectInterval)
 
UInt32 servingTimeout () const
 
void servingTimeout (UInt32 servingTimeout)
 
UInt32 acquisitionTimeout () const
 
void acquisitionTimeout (UInt32 acquisitionTimeout)
 

Detailed Description

Definition at line 30 of file TcpRecovery.h.

Constructor & Destructor Documentation

TcpRecoverySettings ( )
inline

Initializes parameters with default values.

Definition at line 35 of file TcpRecovery.h.

~TcpRecoverySettings ( )
inline

Cleans everything up.

Definition at line 46 of file TcpRecovery.h.

Member Function Documentation

UInt32 acquisitionTimeout ( ) const
inline

Timeout on a TCP recovery service acquisition.

TCP recovery service may process only single request at a time. If TCP recovery service can't be acquired within time defined by given parameter, recovery request will be rejected.

Timeout is measured in milliseconds.

Note
Default value is '500'.

Definition at line 164 of file TcpRecovery.h.

void acquisitionTimeout ( UInt32  acquisitionTimeout)
inline

Timeout of request for shared TCP recovery service. If shared TCP recovery service is used and another Handler instance owned it for processing, this Handler instance will wait for specified timeout and cancel TCP recovery request if TCP Recovery service still not released.

Timeout is measured in milliseconds.

Definition at line 177 of file TcpRecovery.h.

const std::string& password ( ) const
inline

Password to identify a requester while logging on to TCP Recovery service.

Definition at line 68 of file TcpRecovery.h.

void password ( const std::string &  password)
inline

Assigns password to identify a requester while logging on to TCP Recovery service.

Definition at line 76 of file TcpRecovery.h.

UInt32 reconnectAttempts ( ) const
inline

Number of attempts to receive missed messages via the TCP recovery feed.

Note
Default value is '3'.

Definition at line 86 of file TcpRecovery.h.

void reconnectAttempts ( UInt32  reconnectAttempts)
inline

Number of attempts to receive missed messages via the TCP recovery feed.

Definition at line 94 of file TcpRecovery.h.

UInt32 reconnectInterval ( ) const
inline

Interval between the attempts to receive missed packets via the TCP recovery feed if previous attempt either failed or was rejected.

Interval is measured in milliseconds.

Note
Default value is '500'.

Definition at line 108 of file TcpRecovery.h.

void reconnectInterval ( UInt32  reconnectInterval)
inline

Interval between the attempts to receive missed packets via the TCP recovery feed if previous attempt either failed or was rejected.

Interval is measured in milliseconds.

Definition at line 119 of file TcpRecovery.h.

UInt32 servingTimeout ( ) 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 134 of file TcpRecovery.h.

void servingTimeout ( UInt32  servingTimeout)
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 146 of file TcpRecovery.h.

const std::string& username ( ) const
inline

Username to identify a requester while logging on to a TCP Recovery service.

Definition at line 52 of file TcpRecovery.h.

void username ( const std::string &  username)
inline

Assigns username to identify a requester while logging on to a TCP Recovery service.

Definition at line 60 of file TcpRecovery.h.


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