TcpRecoverySettings Class Reference

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

Public Types
enum
enum

Public Member Functions
	TcpRecoverySettings ()
	TcpRecoverySettings (const std::string &username, const std::string &password)
	~TcpRecoverySettings ()
const std::string &	username () const
TcpRecoverySettings &	username (const std::string &username)
const std::string &	password () const
TcpRecoverySettings &	password (const std::string &password)
UInt32	acquisitionTimeout () const
TcpRecoverySettings &	acquisitionTimeout (UInt32 acquisitionTimeout)
UInt32	maxRequests () const
TcpRecoverySettings &	maxRequests (UInt32 maxRequests)
WatchService &	watch () const
TcpRecoverySettings &	watch (WatchService &watch)

Detailed Description

Definition at line 39 of file TcpRecovery.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

The default value of maxRequests().

Enumerator
DefaultMaxRequests	15

Definition at line 46 of file TcpRecovery.h.

anonymous enum

anonymous enum

The default value of acquisitionTimeout().

Enumerator
DefaultAcquisitionTimeout	500

Definition at line 43 of file TcpRecovery.h.

Constructor & Destructor Documentation

TcpRecoverySettings() [1/2]

TcpRecoverySettings ( )

inline

Definition at line 48 of file TcpRecovery.h.

TcpRecoverySettings() [2/2]

TcpRecoverySettings ( const std::string & username, const std::string & password )

inline

Definition at line 57 of file TcpRecovery.h.

~TcpRecoverySettings()

~TcpRecoverySettings ( )

inline

Definition at line 66 of file TcpRecovery.h.

Member Function Documentation

acquisitionTimeout() [1/2]

UInt32 acquisitionTimeout ( ) const

inline

Returns the timeout (in milliseconds) on a TCP Recovery service acquisition.

The recovery request will be rejected if the TCP recovery service cannot be acquired within this period.

The default value is DefaultAcquisitionTimeout.

Definition at line 104 of file TcpRecovery.h.

acquisitionTimeout() [2/2]

TcpRecoverySettings & acquisitionTimeout ( UInt32 acquisitionTimeout )

inline

Sets the timeout (in milliseconds) on a TCP Recovery service acquisition.

The recovery request will be rejected if the TCP recovery service cannot be acquired within this period.

Definition at line 112 of file TcpRecovery.h.

maxRequests() [1/2]

UInt32 maxRequests ( ) const

inline

Returns the maximum number of requests per second.

When this limit is exceeded the recovery attempt is rejected.

The default value is DefaultMaxRequests.

Definition at line 124 of file TcpRecovery.h.

maxRequests() [2/2]

TcpRecoverySettings & maxRequests ( UInt32 maxRequests )

inline

Sets the maximum number of requests per second.

When this limit is exceeded the recovery attempt is rejected.

Definition at line 132 of file TcpRecovery.h.

password() [1/2]

const std::string & password ( ) const

inline

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

Definition at line 86 of file TcpRecovery.h.

password() [2/2]

TcpRecoverySettings & password ( const std::string & password )

inline

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

Definition at line 92 of file TcpRecovery.h.

username() [1/2]

const std::string & username ( ) const

inline

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

Definition at line 70 of file TcpRecovery.h.

username() [2/2]

TcpRecoverySettings & username ( const std::string & username )

inline

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

Definition at line 77 of file TcpRecovery.h.

watch() [1/2]

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 152 of file TcpRecovery.h.

watch() [2/2]

TcpRecoverySettings & watch ( WatchService & watch )

inline

Watch service to be used by the service.

If no instance associated, UTC watch is used.

Definition at line 160 of file TcpRecovery.h.