Reconnection options which will control how a connection deals will connection loss and or inability to connect to the host it was provided at create time. More...

Inheritance diagram for Apache.Qpid.Proton.Client.ReconnectOptions:

Public Member Functions
	ReconnectOptions ()
	Creates a default reconnect options instance.

	ReconnectOptions (ReconnectOptions other)
	Create a new reconnection options instance whose settings are copied from the instance provided.

virtual object	Clone ()
	Clone this options instance, changes to the cloned options are not reflected in this options instance.

ReconnectOptions	AddReconnectLocation (string host, int port)
	Adds the given host and port to the collection of locations where a connection reconnect attempt can be made.

Static Public Attributes
static readonly bool	DEFAULT_RECONNECT_ENABLED = false

static readonly int	INFINITE = -1

static readonly int	DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS = 10

static readonly int	DEFAULT_RECONNECT_DELAY = 10

static readonly int	DEFAULT_MAX_RECONNECT_DELAY = 30_000

static readonly bool	DEFAULT_USE_RECONNECT_BACKOFF = true

static readonly double	DEFAULT_RECONNECT_BACKOFF_MULTIPLIER = 2.0d

Properties
bool	ReconnectEnabled `[get, set]`
	Configure if a connection will attempt reconnection if connection is lost or cannot be established to the primary host provided at create time.

IReadOnlyCollection< ReconnectLocation >	ReconnectLocations `[get, set]`
	Provides access to get or set the list of reconnection locations that are available from these options. The returned collection is read-only amd the provided collection is copied in this options own collection.

int	WarnAfterReconnectAttempts = DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS `[get, set]`
	Controls how often the client will log a message indicating that a reconnection is being attempted. The default is to log every 10 connection attempts.

int	MaxInitialConnectionAttempts = INFINITE `[get, set]`
	For a client that has never connected to a remote peer before this option controls how many attempts are made to connect before reporting the connection as failed. The default behavior is to use the value of maxReconnectAttempts.

int	MaxReconnectAttempts = INFINITE `[get, set]`
	The number of reconnection attempts allowed before reporting the connection as failed to the client. The default is no limit or (-1).

int	ReconnectDelay = DEFAULT_RECONNECT_DELAY `[get, set]`
	Controls the delay between successive reconnection attempts, defaults to 10 milliseconds. If the back off option is not enabled this value remains constant.

int	MaxReconnectDelay = DEFAULT_MAX_RECONNECT_DELAY `[get, set]`
	The maximum time that the client will wait before attempting a reconnect. This value is only used when the back off feature is enabled to ensure that the delay does not grow too large. Defaults to 30 seconds as the max time between successive connection attempts.

bool	UseReconnectBackOff = DEFAULT_USE_RECONNECT_BACKOFF `[get, set]`
	Controls whether the time between reconnection attempts should grow based on a configured multiplier. This option defaults to true.

double	ReconnectBackOffMultiplier = DEFAULT_RECONNECT_BACKOFF_MULTIPLIER `[get, set]`
	The multiplier used to grow the reconnection delay value, defaults to 2.0d.

Detailed Description

Reconnection options which will control how a connection deals will connection loss and or inability to connect to the host it was provided at create time.

Constructor & Destructor Documentation

◆ ReconnectOptions()

Apache.Qpid.Proton.Client.ReconnectOptions.ReconnectOptions ( ReconnectOptions other )

inline

Create a new reconnection options instance whose settings are copied from the instance provided.

Parameters

other The reconnect options instance to copy

Member Function Documentation

◆ AddReconnectLocation()

ReconnectOptions Apache.Qpid.Proton.Client.ReconnectOptions.AddReconnectLocation	(	string	host,
		int	port
	)

inline

Adds the given host and port to the collection of locations where a connection reconnect attempt can be made.

Parameters

host	The host where the connection is made
port	The port on the host where the connection is made

Returns: This reconnection options instance.

◆ Clone()

virtual object Apache.Qpid.Proton.Client.ReconnectOptions.Clone ( )

inlinevirtual

Clone this options instance, changes to the cloned options are not reflected in this options instance.

Returns: A deep copy of this options instance.

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

src/Proton.Client/Client/ReconnectOptions.cs

Public Member Functions