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

Inheritance diagram for Apache.Qpid.Proton.Engine.HeaderEnvelope:

Public Member Functions
void	Invoke< T > (IHeaderHandler< T > handler, T context)
	Invoke the correct handler based on whether this header is a SASL or AMQP header instance. More...

Static Public Attributes
static readonly byte	HeaderFrameType = 1

static readonly HeaderEnvelope	SASL_HEADER_ENVELOPE = new(AmqpHeader.GetSASLHeader())
	A singleton instance of an SASL header that can be used to avoid additional allocations. More...

static readonly HeaderEnvelope	AMQP_HEADER_ENVELOPE = new(AmqpHeader.GetAMQPHeader())
	A singleton instance of an AMQP header that can be used to avoid additional allocations. More...

Properties
int	ProtocolId `[get]`
	Reads the protocol Id value from the conveyed header. More...

int	Major `[get]`
	Reads the major version number value from the conveyed header. More...

int	Minor `[get]`
	Reads the minor version number value from the conveyed header. More...

int	Revision `[get]`
	Reads the revision version number value from the conveyed header. More...

bool	IsSaslHeader `[get]`
	Returns true if the conveyed header is a SASL header. More...

Properties inherited from Apache.Qpid.Proton.Engine.PerformativeEnvelope< AmqpHeader >
T	Body `[get]`
	Access the performative that is the body of this envelope. More...

ushort	Channel `[get]`
	Access the channel on which the performative was received. More...

IProtonBuffer	Payload `[get]`
	Access the payload bytes that arrived with the performative. More...

byte	FrameType `[get]`
	Provides the frame type that defines what types of performatives can be received. More...

Detailed Description

Frame object that carries an AMQP Performative.

Member Function Documentation

◆ Invoke< T >()

void Apache.Qpid.Proton.Engine.HeaderEnvelope.Invoke< T >	(	IHeaderHandler< T >	handler,
		T	context
	)

inline

Invoke the correct handler based on whether this header is a SASL or AMQP header instance.

Template Parameters

T	The context type for the handler invocation

Parameters

handler	The header handler to invoke
context	The context to supply to the handler method.

Member Data Documentation

◆ AMQP_HEADER_ENVELOPE

readonly HeaderEnvelope Apache.Qpid.Proton.Engine.HeaderEnvelope.AMQP_HEADER_ENVELOPE = new(AmqpHeader.GetAMQPHeader())

static

A singleton instance of an AMQP header that can be used to avoid additional allocations.

◆ SASL_HEADER_ENVELOPE

readonly HeaderEnvelope Apache.Qpid.Proton.Engine.HeaderEnvelope.SASL_HEADER_ENVELOPE = new(AmqpHeader.GetSASLHeader())

static

A singleton instance of an SASL header that can be used to avoid additional allocations.

Property Documentation

◆ IsSaslHeader

bool Apache.Qpid.Proton.Engine.HeaderEnvelope.IsSaslHeader

get

Returns true if the conveyed header is a SASL header.

◆ Major

int Apache.Qpid.Proton.Engine.HeaderEnvelope.Major

get

Reads the major version number value from the conveyed header.

◆ Minor

int Apache.Qpid.Proton.Engine.HeaderEnvelope.Minor

get

Reads the minor version number value from the conveyed header.

◆ ProtocolId

int Apache.Qpid.Proton.Engine.HeaderEnvelope.ProtocolId

get

Reads the protocol Id value from the conveyed header.

◆ Revision

int Apache.Qpid.Proton.Engine.HeaderEnvelope.Revision

get

Reads the revision version number value from the conveyed header.

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

src/Proton/Engine/HeaderEnvelope.cs

Public Member Functions

Static Public Attributes

Properties