Public Member Functions | |
| SessionOptions () | |
| Creates a default session options instance. More... | |
| SessionOptions (SessionOptions other) | |
| Create a new session options instance whose settings are copied from the instance provided. More... | |
| object | Clone () |
| Clone this options instance, changes to the cloned options are not reflected in this options instance. More... | |
Static Public Attributes | |
| static readonly uint | DEFAULT_SESSION_INCOMING_CAPACITY = 100 * 1024 * 1024 |
| The default Session configured incoming capacity limit to provide to the remote. More... | |
| static readonly uint | DEFAULT_SESSION_OUTGOING_CAPACITY = 100 * 1024 * 1024 |
| The default Session configured outgoing capacity limit to use to limit pending writes. More... | |
Properties | |
| long | SendTimeout = ConnectionOptions.DEFAULT_SEND_TIMEOUT [get, set] |
| Gets or sets the session 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. More... | |
| long | RequestTimeout = ConnectionOptions.DEFAULT_REQUEST_TIMEOUT [get, set] |
| Gets or sets the session 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. More... | |
| long | OpenTimeout = ConnectionOptions.DEFAULT_OPEN_TIMEOUT [get, set] |
| Gets or sets the session 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. More... | |
| long | CloseTimeout = ConnectionOptions.DEFAULT_CLOSE_TIMEOUT [get, set] |
| Gets or sets the session 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. More... | |
| long | DrainTimeout = ConnectionOptions.DEFAULT_DRAIN_TIMEOUT [get, set] |
| Gets or sets the session 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. More... | |
| string[] | OfferedCapabilities [get, set] |
| Configures the set of capabilities that a new session will advertise to the remote. More... | |
| string[] | DesiredCapabilities [get, set] |
| Sets the collection of capabilities to request from the remote for a new session. The desired capabilities inform the remote peer of the various capabilities the session requires and the remote should return those that it supports in its offered capabilities. More... | |
| NextReceiverPolicy | DefaultNextReceiverPolicy = ConnectionOptions.DEFAULT_NEXT_RECEIVER_POLICY [get, set] |
| Configures the default next receiver policy for this session. More... | |
| IDictionary< string, object > | Properties [get, set] |
| Configures a collection of property values that are sent to the remote upon opening a new session. More... | |
| uint | IncomingCapacity = DEFAULT_SESSION_INCOMING_CAPACITY [get, set] |
| Configures the incoming capacity for each session created with these options. The incoming capacity controls how much buffering a session will allow before applying back pressure to the remote thereby preventing excessive memory overhead. More... | |
| uint | OutgoingCapacity = DEFAULT_SESSION_OUTGOING_CAPACITY [get, set] |
| Configures the outgoing capacity for a session created with these options. The outgoing capacity controls how much buffering a session will allow before applying back pressure to the local thereby preventing excessive memory overhead while writing large amounts of data and the client is experiencing back-pressure due to the remote not keeping pace. More... | |
Constructor & Destructor Documentation
◆ SessionOptions() [1/2]
|
inline |
Creates a default session options instance.
◆ SessionOptions() [2/2]
|
inline |
Create a new session options instance whose settings are copied from the instance provided.
- Parameters
-
other The session options instance to copy
Member Function Documentation
◆ 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.
Member Data Documentation
◆ DEFAULT_SESSION_INCOMING_CAPACITY
|
static |
The default Session configured incoming capacity limit to provide to the remote.
◆ DEFAULT_SESSION_OUTGOING_CAPACITY
|
static |
The default Session configured outgoing capacity limit to use to limit pending writes.
Property Documentation
◆ CloseTimeout
|
getset |
Gets or sets the session 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.
◆ DefaultNextReceiverPolicy
|
getset |
Configures the default next receiver policy for this session.
◆ DesiredCapabilities
|
getset |
Sets the collection of capabilities to request from the remote for a new session. The desired capabilities inform the remote peer of the various capabilities the session requires and the remote should return those that it supports in its offered capabilities.
◆ DrainTimeout
|
getset |
Gets or sets the session 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.
◆ IncomingCapacity
|
getset |
Configures the incoming capacity for each session created with these options. The incoming capacity controls how much buffering a session will allow before applying back pressure to the remote thereby preventing excessive memory overhead.
This is an advanced option and in most cases the client defaults should be left in place unless a specific issue needs to be addressed.
◆ OfferedCapabilities
|
getset |
Configures the set of capabilities that a new session will advertise to the remote.
◆ OpenTimeout
|
getset |
Gets or sets the session 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.
◆ OutgoingCapacity
|
getset |
Configures the outgoing capacity for a session created with these options. The outgoing capacity controls how much buffering a session will allow before applying back pressure to the local thereby preventing excessive memory overhead while writing large amounts of data and the client is experiencing back-pressure due to the remote not keeping pace.
This is an advanced option and in most cases the client defaults should be left in place unless a specific issue needs to be addressed. Setting this value incorrectly can lead to senders that either block frequently or experience very poor overall performance.
◆ Properties
|
getset |
Configures a collection of property values that are sent to the remote upon opening a new session.
◆ RequestTimeout
|
getset |
Gets or sets the session 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.
◆ SendTimeout
|
getset |
Gets or sets the session 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.
The documentation for this class was generated from the following file:
- src/Proton.Client/Client/SessionOptions.cs
