Apache.Qpid.Proton.Client.StreamSenderOptions Class Reference

Special sender options that are applied the streaming senders which allow transmission of large message payloads. More...

Inheritance diagram for Apache.Qpid.Proton.Client.StreamSenderOptions:

Public Member Functions
	StreamSenderOptions ()
	Creates a default stream sender options instance.
	StreamSenderOptions (StreamSenderOptions other)
	Create a new stream sender options instance whose settings are copied from the instance provided.
override object	Clone ()
	Clone this options instance, changes to the cloned options are not reflected in this options instance.
Public Member Functions inherited from Apache.Qpid.Proton.Client.SenderOptions
	SenderOptions ()
	Creates a default sender options instance.
	SenderOptions (SenderOptions other)
	Create a new sender options instance whose settings are copied from the instance provided.

Static Public Attributes
static readonly uint	DEFAULT_PENDING_WRITES_BUFFER_SIZE = SessionOptions.DEFAULT_SESSION_OUTGOING_CAPACITY
	Defines the default pending write buffering size which is used to control how much outgoing data can be buffered for local writing before the sender has back pressured applied to avoid out of memory conditions due to overly large pending batched writes.
static readonly uint	MIN_BUFFER_SIZE_LIMIT = 256
	Defines the default minimum size that the context write buffer will allocate which drives the interval auto flushing of written data for this context.

Properties
uint	WriteBufferSize [get, set]
	Configures the overall number of bytes the stream sender will buffer before automatically flushing the currently buffered bytes. By default the stream sender implementation chooses a value for this buffer limit based on the configured frame size limits of the connection.
uint	PendingWriteBufferSize = DEFAULT_PENDING_WRITES_BUFFER_SIZE [get, set]
	Sets the overall number of bytes the stream sender will allow to be pending for write before applying back pressure to the stream write caller. By default the stream sender implementation chooses a value for this pending write limit based on the configured frame size limits of the connection. This is an advanced option and should not be used unless the impact of doing so is understood by the user.
Properties inherited from Apache.Qpid.Proton.Client.SenderOptions
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< 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.

Detailed Description

Special sender options that are applied the streaming senders which allow transmission of large message payloads.

Constructor & Destructor Documentation

StreamSenderOptions()

Apache.Qpid.Proton.Client.StreamSenderOptions.StreamSenderOptions ( StreamSenderOptions  other )

inline

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

Parameters

other

The stream sender options instance to copy

Member Function Documentation

Clone()

override object Apache.Qpid.Proton.Client.StreamSenderOptions.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 from Apache.Qpid.Proton.Client.SenderOptions.

---

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

• src/Proton.Client/Client/StreamSenderOptions.cs