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

Public Member Functions

 ReceiverOptions ()
 Creates a default receiver options instance.
 
 ReceiverOptions (ReceiverOptions other)
 Create a new receiver 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 Receiver options.
 
TargetOptions TargetOptions = new TargetOptions() [get]
 Gets the target options configuration instance for these Receiver options.
 
string LinkName [get, set]
 Configures the link name that is assigned to the receiver created from these options.
 
bool AutoAccept = true [get, set]
 Controls if receivers created with these options will automatically accept deliveries after they have been delivered to an applications.
 
bool AutoSettle = true [get, set]
 Controls if receivers created with these options will automatically settle deliveries after they have been delivered to an applications.
 
uint CreditWindow = 10 [get, set]
 A credit window value that will be used to maintain an window of credit for Receiver instances that are created from these options. The receiver will allow up to the credit window amount of incoming deliveries to be queued and as they are read from the receiver the window will be extended to maintain a consistent backlog of deliveries. The default is to configure a credit window of 10.
 
DeliveryMode DeliveryMode = DeliveryMode.AtLeastOnce [get, set]
 Configures the delivery mode used by receivers created using these options. By default the receivers will use a delivery mode of at least once.
 
long DrainTimeout = ConnectionOptions.DEFAULT_DRAIN_TIMEOUT [get, set]
 Configures the drain timeout that is used by all receivers created from these options. This value controls how long a receiver waits for the remote to answer a drain request before considering the drain operation to have failed.
 
long RequestTimeout = ConnectionOptions.DEFAULT_REQUEST_TIMEOUT [get, set]
 Configures the request timeout for each receiver created using these options.
 
long OpenTimeout = ConnectionOptions.DEFAULT_OPEN_TIMEOUT [get, set]
 Gets or sets the receiver 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 receiver 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 receiver will advertise to the remote.
 
string[] DesiredCapabilities [get, set]
 Sets the collection of capabilities to request from the remote for a new receiver. 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.
 
IReadOnlyDictionary< string, object > Properties [get, set]
 Configures a collection of property values that are sent to the remote upon opening a new receiver.
 

Constructor & Destructor Documentation

◆ ReceiverOptions()

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

Create a new receiver 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.ReceiverOptions.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.StreamReceiverOptions.

Property Documentation

◆ CreditWindow

uint Apache.Qpid.Proton.Client.ReceiverOptions.CreditWindow = 10
getset

A credit window value that will be used to maintain an window of credit for Receiver instances that are created from these options. The receiver will allow up to the credit window amount of incoming deliveries to be queued and as they are read from the receiver the window will be extended to maintain a consistent backlog of deliveries. The default is to configure a credit window of 10.

To disable credit windowing and allow the client application to control the credit on the receiver link the credit window value should be set to zero.


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