Proton DotNet
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope Class Referencesealed

Frame object that carries an AMQP Performative. More...

Inheritance diagram for Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope:
Apache.Qpid.Proton.Engine.PerformativeEnvelope< IPerformative >

Public Member Functions

void Release ()
 Used to release a Frame that was taken from a Frame pool in order to make it available for the next input operations. Once called the contents of the Frame are invalid and cannot be used again inside the same context.
 
OutgoingAmqpEnvelope HandlePayloadToLarge ()
 Called when the encoder determines that the encoding of the Performative plus any payload value is to large for a single AMQP frame. The configured handler should update the performative in preparation for encoding as a split framed AMQP transfer.
 
OutgoingAmqpEnvelope HandleOutgoingFrameWriteComplete ()
 Called by the encoder when the write of a frame that comprises the transfer of the AMQP performative plus any assigned payload has completed. If the transfer comprises multiple frame writes this handler should be invoked as each frame is successfully written by the IO layer.
 
void Invoke< T > (IPerformativeHandler< T > handler, T context)
 Invoke the correct performative handler event based on the body of this AMQP performative.
 

Static Public Attributes

static readonly byte AmqpFrameType = 0
 

Properties

Action< IPerformativePayloadToLargeHandler [set]
 Configures a handler to be invoked if the payload that is being transmitted with this performative is to large to allow encoding the frame within the maximum configured AMQP frame size limit.
 
Action FrameWriteCompletionHandler [set]
 Configures a handler to be invoked when a write operation that was handed off to the I/O layer has completed indicated that a single frame portion of the payload has been fully written.
 
- Properties inherited from Apache.Qpid.Proton.Engine.PerformativeEnvelope< IPerformative >
Body [get]
 Access the performative that is the body of this envelope.
 
ushort Channel [get]
 Access the channel on which the performative was received.
 
IProtonBuffer Payload [get]
 Access the payload bytes that arrived with the performative.
 
byte FrameType [get]
 Provides the frame type that defines what types of performatives can be received.
 

Detailed Description

Frame object that carries an AMQP Performative.

Member Function Documentation

◆ HandleOutgoingFrameWriteComplete()

OutgoingAmqpEnvelope Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.HandleOutgoingFrameWriteComplete ( )
inline

Called by the encoder when the write of a frame that comprises the transfer of the AMQP performative plus any assigned payload has completed. If the transfer comprises multiple frame writes this handler should be invoked as each frame is successfully written by the IO layer.

Returns
This outgoing performative envelope instance.

◆ HandlePayloadToLarge()

OutgoingAmqpEnvelope Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.HandlePayloadToLarge ( )
inline

Called when the encoder determines that the encoding of the Performative plus any payload value is to large for a single AMQP frame. The configured handler should update the performative in preparation for encoding as a split framed AMQP transfer.

Returns
This outgoing performative envelope instance.

◆ Invoke< T >()

void Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.Invoke< T > ( IPerformativeHandler< T >  handler,
context 
)
inline

Invoke the correct performative handler event based on the body of this AMQP performative.

Template Parameters
TThe type of context that will be provided to the invocation
Parameters
handlerThe handle to invoke an event on.
contextThe context to pass to the event invocation

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