A specialized streaming message type used to operate on a streamed message which allows message data to be written in one or more transfer frames to the remote allowing for very large message transmission with limited memory overhead. More...

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

Public Member Functions
IStreamSenderMessage	Complete ()
	Marks the currently streaming message as being complete. Marking a message as complete finalizes the streaming send operation and causes a final transfer frame to be sent to the remote indicating that the ongoing streaming delivery is done and no more message data will arrive.

IStreamSenderMessage	Abort ()
	Marks the currently streaming message as being aborted. Once aborted no further writes regardless of whether any writes have yet been performed or not.

Stream	GetBodyStream (OutputStreamOptions options=null)
	Creates an write only stream instance configured with the given options which will write the bytes as the payload of one or more AMQP data sections based on the provided configuration..

Stream	RawOutputStream ()

Public Member Functions inherited from Apache.Qpid.Proton.Client.IAdvancedMessage< Stream >
IAdvancedMessage< T >	AddBodySection (ISection section)
	Adds the given section to the internal collection of sections that will be sent to the remote peer when this message is encoded. If a previous section was added by a call to the set body method it should be retained as the first element of the running list of body sections contained in this message.

IAdvancedMessage< T >	SetBodySections (IEnumerable< ISection > section)
	Sets the body section instances to use when encoding this message. The value set replaces any existing sections assigned to this message through the add body sections API or the singular body set method. Calling the set method with a null or empty enumerable is equivalent to calling the clear body sections method. The values from the passed enumerable are copied and changes to it following calls to this method are not reflected in the collection contained in this message.

IEnumerable< ISection >	GetBodySections ()
	Create and return an unmodifiable read-only view that contains the section instances currently assigned to this message.

IAdvancedMessage< T >	ClearBodySections ()
	Clears all currently set body sections from this message instance.

IAdvancedMessage< T >	ForEachBodySection (Action< ISection > consumer)
	Efficient enumeration over all currently assigned body sections in this message.

IProtonBuffer	Encode (IDictionary< string, object > deliveryAnnotations)
	Encodes the advanced message for transmission by the client. The provided delivery annotations can be included or augmented by the advanced implementation based on the target message format. The implementation is responsible for ensuring that the delivery annotations are treated correctly encoded into the correct location in the message.

Properties
IStreamTracker	Tracker `[get]`
	Returns the stream tracker that is associated with this outgoing stream message.

IStreamSender	Sender `[get]`
	Returns the stream sender instance that owns this outgoing stream message.

bool	Completed `[get]`
	Returns if the outgoing stream message has been completed.

bool	Aborted `[get]`
	Returns if the outgoing stream message has been aborted.

Properties inherited from Apache.Qpid.Proton.Client.IAdvancedMessage< Stream >
Header	Header `[get, set]`
	Provides access to the AMQP Header instance that is carried in the message.

Properties	Properties `[get, set]`
	Provides access to the AMQP Properties instance that is carried in the message.

MessageAnnotations	Annotations `[get, set]`
	Provides access to the AMQP MessageAnnotations instance that is carried in the message.

ApplicationProperties	ApplicationProperties `[get, set]`
	Provides access to the AMQP ApplicationProperties instance that is carried in the message.

Footer	Footer `[get, set]`
	Provides access to the AMQP Footer instance that is carried in the message.

uint	MessageFormat `[get, set]`
	Access the message format value present in this message. The exact structure of a message, together with its encoding, is defined by the message format (default is the AMQP defined message format zero.

Additional Inherited Members
Static Public Member Functions inherited from Apache.Qpid.Proton.Client.IAdvancedMessage< Stream >
static new IAdvancedMessage< T >	Create ()
	Creates a new advanced message instance using the Proton implementation.

Detailed Description

A specialized streaming message type used to operate on a streamed message which allows message data to be written in one or more transfer frames to the remote allowing for very large message transmission with limited memory overhead.

Member Function Documentation

◆ Abort()

IStreamSenderMessage Apache.Qpid.Proton.Client.IStreamSenderMessage.Abort ( )

Marks the currently streaming message as being aborted. Once aborted no further writes regardless of whether any writes have yet been performed or not.

Returns: This outgoing stream message instance

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

◆ Complete()

IStreamSenderMessage Apache.Qpid.Proton.Client.IStreamSenderMessage.Complete ( )

Marks the currently streaming message as being complete. Marking a message as complete finalizes the streaming send operation and causes a final transfer frame to be sent to the remote indicating that the ongoing streaming delivery is done and no more message data will arrive.

Returns: This outgoing stream message instance

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

◆ GetBodyStream()

Stream Apache.Qpid.Proton.Client.IStreamSenderMessage.GetBodyStream ( OutputStreamOptions options = null )

Creates an write only stream instance configured with the given options which will write the bytes as the payload of one or more AMQP data sections based on the provided configuration..

Parameters

options options to apply to the created stream

Returns: A write only stream instance used to write the message body

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

◆ RawOutputStream()

Stream Apache.Qpid.Proton.Client.IStreamSenderMessage.RawOutputStream ( )

Returns

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

Property Documentation

◆ Aborted

bool Apache.Qpid.Proton.Client.IStreamSenderMessage.Aborted

get

Returns if the outgoing stream message has been aborted.

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

◆ Completed

bool Apache.Qpid.Proton.Client.IStreamSenderMessage.Completed

get

Returns if the outgoing stream message has been completed.

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

◆ Sender

IStreamSender Apache.Qpid.Proton.Client.IStreamSenderMessage.Sender

get

Returns the stream sender instance that owns this outgoing stream message.

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

◆ Tracker

IStreamTracker Apache.Qpid.Proton.Client.IStreamSenderMessage.Tracker

get

Returns the stream tracker that is associated with this outgoing stream message.

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage.

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

src/Proton.Client/Client/IStreamSenderMessage.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Abort()

◆ Complete()

◆ GetBodyStream()

◆ RawOutputStream()

Property Documentation

◆ Aborted

◆ Completed

◆ Sender

◆ Tracker