Apache.Qpid.Proton.Codec.IDecoderState Interface Reference

Defines a state object that is used with the AMQP Decoder type to hold intermediate state and provide additional functionality that can be used during the decode process. More...

Inheritance diagram for Apache.Qpid.Proton.Codec.IDecoderState:

Public Member Functions
void	Reset ()
	Resets the decoder after a complete decode operation freeing any held resources and preparing for a new decode operation.
string	DecodeUtf8 (IProtonBuffer buffer, int length)
	Decodes an encoded UTF-8 string value from the given buffer. The number of bytes that comprise the encoding is provided by the caller, the decoder should not read more than that number of bytes from the provided buffer.

Properties
IDecoder	Decoder [get]
	Gets the IDecoder instance that was used when creating this decoder state object.

Detailed Description

Defines a state object that is used with the AMQP Decoder type to hold intermediate state and provide additional functionality that can be used during the decode process.

Member Function Documentation

DecodeUtf8()

string Apache.Qpid.Proton.Codec.IDecoderState.DecodeUtf8	(	IProtonBuffer	buffer,
		int	length
	)

Decodes an encoded UTF-8 string value from the given buffer. The number of bytes that comprise the encoding is provided by the caller, the decoder should not read more than that number of bytes from the provided buffer.

Parameters

buffer	The buffer where the bytes are to be read from.
length	The encoded size of the UTF-8 string.

Returns

A string value decoded from the UTF-8 bytes

Implemented in Apache.Qpid.Proton.Codec.Decoders.ProtonDecoderState.

Reset()

void Apache.Qpid.Proton.Codec.IDecoderState.Reset

(

)

Resets the decoder after a complete decode operation freeing any held resources and preparing for a new decode operation.

Implemented in Apache.Qpid.Proton.Codec.Decoders.ProtonDecoderState.

Property Documentation

Decoder

IDecoder Apache.Qpid.Proton.Codec.IDecoderState.Decoder

get

Gets the IDecoder instance that was used when creating this decoder state object.

Implemented in Apache.Qpid.Proton.Codec.Decoders.ProtonDecoderState.

---

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

• src/Proton/Codec/IDecoderState.cs