reconnect_options Class Reference

**Unsettled API** - Options for reconnect and failover after connection loss. More...

#include <reconnect_options.hpp>

List of all members.

Public Member Functions

 reconnect_options ()
 Create an empty set of options.
 reconnect_options (const reconnect_options &)
 Copy options.
reconnect_optionsoperator= (const reconnect_options &)
 Copy options.
reconnect_optionsdelay (duration)
 The base value for recurring delays.
reconnect_optionsdelay_multiplier (float)
 The scaling multiplier for successive reconnect delays.
reconnect_optionsmax_delay (duration)
 The maximum delay between successive connect attempts.
reconnect_optionsmax_attempts (int)
 The maximum number of reconnect attempts.
reconnect_optionsfailover_urls (const std::vector< std::string > &conn_urls)
 Deprecated - use connection_options::failover_urls Alternative connection URLs used for failover.

Detailed Description

**Unsettled API** - Options for reconnect and failover after connection loss.

These options determine a series of delays to coordinate reconnection attempts. They may be open-ended or limited in time. They may be evenly spaced or increasing at an exponential rate.

Normal value semantics: copy or assign creates a separate copy of the options.

See also:
messaging_handler, connection_options::reconnect()

Member Function Documentation

reconnect_options& delay ( duration   ) 

The base value for recurring delays.

The default is 10 milliseconds.

reconnect_options& delay_multiplier ( float   ) 

The scaling multiplier for successive reconnect delays.

The default is 2.0.

reconnect_options& max_delay ( duration   ) 

The maximum delay between successive connect attempts.

The default duration::FOREVER, meaning no limit.

reconnect_options& max_attempts ( int   ) 

The maximum number of reconnect attempts.

The default is 0, meaning no limit.

reconnect_options& failover_urls ( const std::vector< std::string > &  conn_urls  ) 

Deprecated - use connection_options::failover_urls Alternative connection URLs used for failover.

There are none by default.


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

Generated on 8 Oct 2019 for Qpid Proton C++ by  doxygen 1.6.1