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

Public Member Functions

 SenderOptions ()
 Creates a default sender options instance.
 
 SenderOptions (SenderOptions other)
 Create a new sender 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.
 

Properties

SourceOptions SourceOptions = new SourceOptions() [get]
 Gets the source options configuration instance for these Sender options.
 
TargetOptions TargetOptions = new TargetOptions() [get]
 Gets the target options configuration instance for these Sender options.
 
string LinkName [get, set]
 Configures the link name that is assigned to the sender created from these options.
 
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.
 
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.
 
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.
 
long RequestTimeout = ConnectionOptions.DEFAULT_REQUEST_TIMEOUT [get, set]
 Configures the request timeout for each sender created using these options.
 
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.
 
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.
 
string[] OfferedCapabilities [get, set]
 Configures the set of capabilities that a new sender will advertise to the remote.
 
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.
 
IDictionary< string, object > Properties [get, set]
 Configures a collection of property values that are sent to the remote upon opening a new sender.
 
Func< IDeliveryTagGeneratorDeliveryTagGeneratorSupplier [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.
 

Constructor & Destructor Documentation

◆ SenderOptions()

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

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

Parameters
otherThe sender options instance to copy

Member Function Documentation

◆ Clone()

virtual object Apache.Qpid.Proton.Client.SenderOptions.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

◆ DeliveryTagGeneratorSupplier

Func<IDeliveryTagGenerator> Apache.Qpid.Proton.Client.SenderOptions.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.


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