Proton DotNet
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
Apache.Qpid.Proton.Client.ConnectionOptions Class Reference
Inheritance diagram for Apache.Qpid.Proton.Client.ConnectionOptions:

Public Member Functions

 ConnectionOptions ()
 Creates a default Connection options instance.
 
 ConnectionOptions (ConnectionOptions other)
 Create a new Connection options instance whose settings are copied from the instance provided.
 
object Clone ()
 Clone this options instance, changes to the cloned options are not reflected in this options instance.
 

Static Public Attributes

static readonly long INFINITE = -1
 
static readonly long DEFAULT_OPEN_TIMEOUT = 15000
 
static readonly long DEFAULT_CLOSE_TIMEOUT = 60000
 
static readonly long DEFAULT_SEND_TIMEOUT = INFINITE
 
static readonly long DEFAULT_REQUEST_TIMEOUT = INFINITE
 
static readonly uint DEFAULT_IDLE_TIMEOUT = 60000
 
static readonly long DEFAULT_DRAIN_TIMEOUT = 60000
 
static readonly ushort DEFAULT_CHANNEL_MAX = 65535
 
static readonly uint DEFAULT_MAX_FRAME_SIZE = 65536
 
static readonly NextReceiverPolicy DEFAULT_NEXT_RECEIVER_POLICY = NextReceiverPolicy.RoundRobin
 

Properties

string User [get, set]
 Configure the user name that is conveyed to the remote peer when a new connection is being opened.
 
string Password [get, set]
 Configure the password that is conveyed to the remote peer when a new connection is being opened.
 
string VirtualHost [get, set]
 Configure the virtual host value that is conveyed to the remote peer when a new connection is being opened.
 
long SendTimeout = DEFAULT_SEND_TIMEOUT [get, set]
 Gets or sets the connection level send timeout value which will be used as the defaults if child resources are not created with their own options type. This timeout controls how long a sender will wait for a send to complete before giving up and signalling a send failure.
 
long RequestTimeout = DEFAULT_REQUEST_TIMEOUT [get, set]
 Gets or sets the connection level request timeout value which will be used as the defaults if child resources are not created with their own options type. The request timeout applies to client specific actions that require a remote response such as the begin or end of a transaction.
 
long OpenTimeout = DEFAULT_OPEN_TIMEOUT [get, set]
 Gets or sets the connection level open timeout value which will be used as the defaults if child resources are not created with their own options type. Controls how long a client will wait for a remote to respond to the open of a resource before signalling that the open has failed.
 
long CloseTimeout = DEFAULT_CLOSE_TIMEOUT [get, set]
 Gets or sets the connection level close timeout value which will be used as the defaults if child resources are not created with their own options type. Controls how long the remote will wait for the remote to respond to a close request for a resource before giving up and signalling an error has occurred.
 
uint IdleTimeout = DEFAULT_IDLE_TIMEOUT [get, set]
 Gets or sets the connection level idle timeout value which will be used as the defaults if child resources are not created with their own options type. Controls the idle processing timeout that is sent to the remote informing it up the clients expectation for how long it can remain idle before needing to send a heart beat. The client sends half the configured value to the remote.
 
long DrainTimeout = DEFAULT_DRAIN_TIMEOUT [get, set]
 Gets or sets the connection level drain timeout value which will be used as the defaults if child resources are not created with their own options type. Controls how long the drain of a receiver link and remain outstanding before it is considered failed and an error is signalled indicating that the drain attempt failed.
 
ushort ChannelMax = DEFAULT_CHANNEL_MAX [get, set]
 Configure the channel maximum value for the new connection created with these options. The channel max value controls how many session instances can be created by a given Connection, the default value is 65535.
 
uint MaxFrameSize = DEFAULT_MAX_FRAME_SIZE [get, set]
 Configures the max frame size that will be communicated to the remote peer instructing it that this client cannot receive frames larger than this value. This also controls the size of the frames this peer will output unless the remote has requested a smaller value than what is set here.
 
NextReceiverPolicy DefaultNextReceiverPolicy = DEFAULT_NEXT_RECEIVER_POLICY [get, set]
 Configures the default next receiver policy for this connection and any session that is created without specifying user defined session default options.
 
string[] OfferedCapabilities [get, set]
 Configures the set of capabilities that a new connection will advertise to the remote.
 
string[] DesiredCapabilities = DEFAULT_DESIRED_CAPABILITIES_ARRAY [get, set]
 Sets the collection of capabilities to request from the remote for a new connection. The desired capabilities inform the remote peer of the various capabilities the connection requires and the remote should return those that it supports in its offered capabilities.
 
IDictionary< string, object > Properties [get, set]
 Configures a collection of property values that are sent to the remote upon opening a new connection.
 
SaslOptions SaslOptions = new SaslOptions() [get]
 Gets the SASL options instance associated with these connection options.
 
bool ReconnectEnabled [get, set]
 Quick access to enable and disable reconnection for newly created connections that use these options.
 
ReconnectOptions ReconnectOptions = new ReconnectOptions() [get]
 Gets the Reconnection options that control client reconnection behavior.
 
bool TraceFrames [get, set]
 Controls if the client will attempt to trigger the AMQP engine to trace all incoming and outgoing frames via the logger.
 
TransportOptions TransportOptions = new TransportOptions() [get]
 Configuration of the I/O layer options.
 
bool SslEnabled [get, set]
 Quick access to enable and disable SSL for newly created connections that use these options.
 
SslOptions SslOptions = new SslOptions() [get]
 Configuration that controls the SSL I/O layer if enabled.
 
Action< IConnection, ConnectionEventConnectedHandler [get, set]
 Register and action that will be fired asynchronously to signal that the client has connected to a remote peer. It is a programming error for the signaled handler to throw an exception and the outcome of such an error is unspecified.
 
Action< IConnection, ConnectionEventReconnectedHandler [get, set]
 Register and action that will be fired asynchronously to signal that the client has reconnected to a remote peer. It is a programming error for the signaled handler to throw an exception and the outcome of such an error is unspecified.
 
Action< IConnection, DisconnectionEventInterruptedHandler [get, set]
 Register and action that will be fired asynchronously to signal that the client has been disconnected from a remote peer but will attempt to reconnect using configured reconnection options. It is a programming error for the signaled handler to throw an exception and the outcome of such an error is unspecified.
 
Action< IConnection, DisconnectionEventDisconnectedHandler [get, set]
 Register and action that will be fired asynchronously to signal that the client has been disconnected from a remote peer. It is a programming error for the signaled handler to throw an exception and the outcome of such an error is unspecified.
 

Constructor & Destructor Documentation

◆ ConnectionOptions()

Apache.Qpid.Proton.Client.ConnectionOptions.ConnectionOptions ( ConnectionOptions  other)
inline

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

Parameters
otherThe connection options instance to copy

Member Function Documentation

◆ Clone()

object Apache.Qpid.Proton.Client.ConnectionOptions.Clone ( )
inline

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: