TcpRecoverySettings Class Reference

#include <OnixS/CME/ConflatedUDP/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	acquisitionTimeout () const
void	acquisitionTimeout (UInt32 acquisitionTimeout)
UInt32	maxRequests () const
void	maxRequests (UInt32 maxRequests)
WatchService &	watch () const
void	watch (WatchService &watch)

Detailed Description

Definition at line 46 of file TcpRecovery.h.

Constructor & Destructor Documentation

TcpRecoverySettings ( )

inline

Initializes parameters with default values.

Definition at line 60 of file TcpRecovery.h.

~TcpRecoverySettings ( )

inline

Cleans everything up.

Definition at line 70 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 122 of file TcpRecovery.h.

void acquisitionTimeout ( UInt32  acquisitionTimeout )

inline

Defines the wait time limit while acquiring a TCP recovery service.

If TCP recovery service is used and the other Handler instance gained access to the service to recover missing data, the Handler instance will wait for the given time to acquire the service and will cancel the TCP recovery request if service wasn't acquired for the given time period.

Timeout is measured in milliseconds.

Definition at line 140 of file TcpRecovery.h.

UInt32 maxRequests ( ) const

inline

Maximal number of requests per second.

By default, the service is limited to serve 15 requests per second.

Definition at line 151 of file TcpRecovery.h.

void maxRequests ( UInt32  maxRequests )

inline

Limits number of requests per second.

If the established limit is exceeded a recovery attempt is rejected by service.

Definition at line 161 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 96 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 104 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 78 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 86 of file TcpRecovery.h.

WatchService& watch ( ) const

inline

Watch service to be used by the service.

Watch is used by the service while restricting number of incoming requests.

Note

By default, UTC watch service is used.

Definition at line 180 of file TcpRecovery.h.

void watch ( WatchService &  watch )

inline

Watch service to be used by the service.

If no instance associated, UTC watch is used.

Definition at line 189 of file TcpRecovery.h.

---

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

• include/OnixS/CME/ConflatedUDP/TcpRecovery.h