Options class that controls various aspects of a write only stream instance created to write the contents of a section of a stream sender message. More...

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

Public Member Functions
	OutputStreamOptions ()
	Creates a default output stream options instance.

	OutputStreamOptions (OutputStreamOptions other)
	Create a new output stream 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.

Static Public Attributes
static readonly bool	DEFAULT_COMPLETE_SEND_ON_CLOSE = true

Properties
bool	CompleteSendOnClose = DEFAULT_COMPLETE_SEND_ON_CLOSE `[get, set]`
	Configures if the close of the `OutputStream` should result in a completion of the parent stream sender message (default is true). If there is a configured stream size and the stream is closed the parent stream sender message will always be aborted as the send would be incomplete, but the close of an Stream may not always be the desired outcome. In the case the user wishes to add a footer to the message transmitted by the stream sender message this option should be set to false and the user should complete the stream manually.

int	BodyLength `[get, set]`
	Sets the overall stream size for this associated `OutputStream` that the options are applied to.

Detailed Description

Options class that controls various aspects of a write only stream instance created to write the contents of a section of a stream sender message.

Constructor & Destructor Documentation

◆ OutputStreamOptions()

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

inline

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

Parameters

other The sender options instance to copy

Member Function Documentation

◆ Clone()

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

Property Documentation

◆ BodyLength

int Apache.Qpid.Proton.Client.OutputStreamOptions.BodyLength

getset

Sets the overall stream size for this associated OutputStream that the options are applied to.

When set this option indicates the number of bytes that can be written to the stream before an error would be thrown indicating that this value was exceeded. Conversely if the stream is closed before the number of bytes indicated is written the send will be aborted and an error will be thrown to the caller.

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

src/Proton.Client/Client/OutputStreamOptions.cs

Public Member Functions

Static Public Attributes