Public Member Functions | |
| SenderOptions () | |
| Creates a default sender options instance. More... | |
| SenderOptions (SenderOptions other) | |
| Create a new sender options instance whose settings are copied from the instance provided. More... | |
| virtual object | Clone () |
| Clone this options instance, changes to the cloned options are not reflected in this options instance. More... | |
Properties | |
| SourceOptions | SourceOptions = new SourceOptions() [get] |
| Gets the source options configuration instance for these Sender options More... | |
| TargetOptions | TargetOptions = new TargetOptions() [get] |
| Gets the target options configuration instance for these Sender options More... | |
| string | LinkName [get, set] |
| Configures the link name that is assigned to the sender created from these options. More... | |
| DeliveryMode | DeliveryMode = DeliveryMode.AtLeastOnce [get, set] |
| Configures the delivery mode used by senders created using these options. By default the senders will use a delivery mode of at least once. More... | |
| bool | AutoSettle = true [get, set] |
| Configures whether senders created using these options will automatically settle deliveries that were sent once the remote responds that the send was accepted and settled. More... | |
| long | SendTimeout = ConnectionOptions.DEFAULT_SEND_TIMEOUT [get, set] |
| Configures the send timeout for each sender created using these options. 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] |
| Configures the request timeout for each sender created using these options. More... | |
| long | OpenTimeout = ConnectionOptions.DEFAULT_OPEN_TIMEOUT [get, set] |
| Gets or sets the sender open timeout value which will be used as the for all senders created using these options. 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 sender close timeout value which will be used as the for all senders created using these options. Controls how long a client will wait for a remote to respond to the open of a resource before signalling that the close has failed. More... | |
| string[] | OfferedCapabilities [get, set] |
| Configures the set of capabilities that a new sender will advertise to the remote. More... | |
| string[] | DesiredCapabilities [get, set] |
| Sets the collection of capabilities to request from the remote for a new sender. The desired capabilities inform the remote peer of the various capabilities the sender requires and the remote should return those that it supports in its offered capabilities. More... | |
| IDictionary< string, object > | Properties [get, set] |
| Configures a collection of property values that are sent to the remote upon opening a new sender. More... | |
| Func< IDeliveryTagGenerator > | DeliveryTagGeneratorSupplier [get, set] |
| Configures a supplier that provides the Delivery Tag Generator instance which the Sender created using these options will use when setting the delivery tag on outgoing deliveries. More... | |
Constructor & Destructor Documentation
◆ SenderOptions() [1/2]
|
inline |
Creates a default sender options instance.
◆ SenderOptions() [2/2]
|
inline |
Create a new sender options instance whose settings are copied from the instance provided.
- Parameters
-
other The sender options instance to copy
Member Function Documentation
◆ 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.
Reimplemented in Apache.Qpid.Proton.Client.StreamSenderOptions.
Property Documentation
◆ AutoSettle
|
getset |
Configures whether senders created using these options will automatically settle deliveries that were sent once the remote responds that the send was accepted and settled.
◆ CloseTimeout
|
getset |
Gets or sets the sender close timeout value which will be used as the for all senders created using these options. Controls how long a client will wait for a remote to respond to the open of a resource before signalling that the close has failed.
◆ DeliveryMode
|
getset |
Configures the delivery mode used by senders created using these options. By default the senders will use a delivery mode of at least once.
◆ DeliveryTagGeneratorSupplier
|
getset |
Configures a supplier that provides the Delivery Tag Generator instance which the Sender created using these options will use when setting the delivery tag on outgoing deliveries.
The client sender will use a default delivery tag generator unless a supplier is configured here as such this options is not required to be used. In some cases a client application may want to control exactly what form of delivery tag is used on outgoing deliveries and this mechanism provides that control. The caller is responsible for providing a supplier that will provide unique instance of a tag generator for any sender created with this options instance as the tag generators are not meant to be shared resources.
◆ DesiredCapabilities
|
getset |
Sets the collection of capabilities to request from the remote for a new sender. The desired capabilities inform the remote peer of the various capabilities the sender requires and the remote should return those that it supports in its offered capabilities.
◆ LinkName
|
getset |
Configures the link name that is assigned to the sender created from these options.
◆ OfferedCapabilities
|
getset |
Configures the set of capabilities that a new sender will advertise to the remote.
◆ OpenTimeout
|
getset |
Gets or sets the sender open timeout value which will be used as the for all senders created using these options. 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.
◆ Properties
|
getset |
Configures a collection of property values that are sent to the remote upon opening a new sender.
◆ RequestTimeout
|
getset |
Configures the request timeout for each sender created using these options.
◆ SendTimeout
|
getset |
Configures the send timeout for each sender created using these options. This timeout controls how long a sender will wait for a send to complete before giving up and signalling a send failure.
◆ SourceOptions
|
get |
Gets the source options configuration instance for these Sender options
◆ TargetOptions
|
get |
Gets the target options configuration instance for these Sender options
The documentation for this class was generated from the following file:
- src/Proton.Client/Client/SenderOptions.cs
