Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder Class Reference

Inheritance diagram for Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder:

Public Member Functions
IDecoderState	NewDecoderState ()
	Creates and returns a new decoder state object that should be used when decoding values with the decoder instance.
bool?	ReadBoolean (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
bool	ReadBoolean (IProtonBuffer buffer, IDecoderState state, bool defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
sbyte?	ReadByte (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
sbyte	ReadByte (IProtonBuffer buffer, IDecoderState state, sbyte defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
byte?	ReadUnsignedByte (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
byte	ReadUnsignedByte (IProtonBuffer buffer, IDecoderState state, byte defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
char?	ReadCharacter (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
char	ReadCharacter (IProtonBuffer buffer, IDecoderState state, char defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
Decimal32	ReadDecimal32 (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
Decimal64	ReadDecimal64 (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
Decimal128	ReadDecimal128 (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
short?	ReadShort (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
short	ReadShort (IProtonBuffer buffer, IDecoderState state, short defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
ushort?	ReadUnsignedShort (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
ushort	ReadUnsignedShort (IProtonBuffer buffer, IDecoderState state, ushort defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
int?	ReadInteger (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
int	ReadInteger (IProtonBuffer buffer, IDecoderState state, int defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
uint?	ReadUnsignedInteger (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
uint	ReadUnsignedInteger (IProtonBuffer buffer, IDecoderState state, uint defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
long?	ReadLong (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
long	ReadLong (IProtonBuffer buffer, IDecoderState state, long defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
ulong?	ReadUnsignedLong (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
ulong	ReadUnsignedLong (IProtonBuffer buffer, IDecoderState state, ulong defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
float?	ReadFloat (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
float	ReadFloat (IProtonBuffer buffer, IDecoderState state, float defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
double?	ReadDouble (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
double	ReadDouble (IProtonBuffer buffer, IDecoderState state, double defaultValue)
	Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
IProtonBuffer	ReadBinary (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
string	ReadString (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
Symbol	ReadSymbol (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
string	ReadSymbolAsString (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
ulong?	ReadTimestamp (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
Guid?	ReadGuid (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
IDictionary< K, V >	ReadMap< K, V > (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
IList< T >	ReadList< T > (IProtonBuffer buffer, IDecoderState state)
object	ReadObject (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
T	ReadObject< T > (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
T[]	ReadMultiple< T > (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.
IDeliveryTag	ReadDeliveryTag (IProtonBuffer buffer, IDecoderState state)
	This method expects to read a Binary encoded type from the provided stream and constructs a IDeliveryTag type that wraps the bytes encoded. If the encoding is NULL AMQP type then this method returns null.
ITypeDecoder	ReadNextTypeDecoder (IProtonBuffer buffer, IDecoderState state)
	Reads from the given IProtonBuffer instance and returns a ITypeDecoder that can read the next encoded AMQP type from the byte stream. If an error occurs while attempting to read the encoded type a DecodeException is thrown.
ITypeDecoder	PeekNextTypeDecoder (IProtonBuffer buffer, IDecoderState state)
	Peeks ahead in the given IProtonBuffer instance and returns a ITypeDecoder that can read the next encoded AMQP type from the byte stream. If an error occurs while attempting to read the encoded type a DecodeException is thrown. The underlying buffer state is not modified as a result of calling the peek ahead operation and the returned decoder will not correctly be able to read the encoded type until the type encoding bytes are read.
IDecoder	RegisterDescribedTypeDecoder (IDescribedTypeDecoder decoder)
	Allows for a custom described type decoder to be registered with this decoder instance for use when decoding AMQP described types from incoming byte streams.
Public Member Functions inherited from Apache.Qpid.Proton.Codec.IDecoder
IList< V >	ReadList< V > (IProtonBuffer buffer, IDecoderState state)
	Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Properties
IDecoderState	CachedDecoderState [get]
	Returns a cached decoder state instance that can be used be single threaded readers that use this decoder instance.
Properties inherited from Apache.Qpid.Proton.Codec.IDecoder

Member Function Documentation

NewDecoderState()

IDecoderState Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.NewDecoderState ( )

inline

Creates and returns a new decoder state object that should be used when decoding values with the decoder instance.

Returns

Implements Apache.Qpid.Proton.Codec.IDecoder.

PeekNextTypeDecoder()

ITypeDecoder Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.PeekNextTypeDecoder ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Peeks ahead in the given IProtonBuffer instance and returns a ITypeDecoder that can read the next encoded AMQP type from the byte stream. If an error occurs while attempting to read the encoded type a DecodeException is thrown. The underlying buffer state is not modified as a result of calling the peek ahead operation and the returned decoder will not correctly be able to read the encoded type until the type encoding bytes are read.

Template Parameters

T	The type that the decoder handles

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadBinary()

IProtonBuffer Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadBinary ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadBoolean() [1/2]

bool? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadBoolean ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadBoolean() [2/2]

bool Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadBoolean ( IProtonBuffer  buffer, IDecoderState  state, bool  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadByte() [1/2]

sbyte? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadByte ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadByte() [2/2]

sbyte Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadByte ( IProtonBuffer  buffer, IDecoderState  state, sbyte  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadCharacter() [1/2]

char? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadCharacter ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadCharacter() [2/2]

char Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadCharacter ( IProtonBuffer  buffer, IDecoderState  state, char  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadDecimal128()

Decimal128 Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadDecimal128 ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadDecimal32()

Decimal32 Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadDecimal32 ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadDecimal64()

Decimal64 Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadDecimal64 ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadDeliveryTag()

IDeliveryTag Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadDeliveryTag ( IProtonBuffer  buffer, IDecoderState  state  )

inline

This method expects to read a Binary encoded type from the provided stream and constructs a IDeliveryTag type that wraps the bytes encoded. If the encoding is NULL AMQP type then this method returns null.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadDouble() [1/2]

double? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadDouble ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadDouble() [2/2]

double Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadDouble ( IProtonBuffer  buffer, IDecoderState  state, double  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadFloat() [1/2]

float? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadFloat ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadFloat() [2/2]

float Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadFloat ( IProtonBuffer  buffer, IDecoderState  state, float  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadGuid()

Guid? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadGuid ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadInteger() [1/2]

int? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadInteger ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadInteger() [2/2]

int Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadInteger ( IProtonBuffer  buffer, IDecoderState  state, int  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadLong() [1/2]

long? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadLong ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadLong() [2/2]

long Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadLong ( IProtonBuffer  buffer, IDecoderState  state, long  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadMap< K, V >()

IDictionary< K, V > Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadMap< K, V > ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadMultiple< T >()

T[] Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadMultiple< T > ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadNextTypeDecoder()

ITypeDecoder Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadNextTypeDecoder ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads from the given IProtonBuffer instance and returns a ITypeDecoder that can read the next encoded AMQP type from the byte stream. If an error occurs while attempting to read the encoded type a DecodeException is thrown.

Template Parameters

T	The type that the decoder handles

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadObject()

object Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadObject ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadObject< T >()

T Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadObject< T > ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadShort() [1/2]

short? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadShort ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadShort() [2/2]

short Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadShort ( IProtonBuffer  buffer, IDecoderState  state, short  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadString()

string Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadString ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadSymbol()

Symbol Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadSymbol ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadSymbolAsString()

string Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadSymbolAsString ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadTimestamp()

ulong? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadTimestamp ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedByte() [1/2]

byte? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedByte ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedByte() [2/2]

byte Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedByte ( IProtonBuffer  buffer, IDecoderState  state, byte  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedInteger() [1/2]

uint? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedInteger ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedInteger() [2/2]

uint Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedInteger ( IProtonBuffer  buffer, IDecoderState  state, uint  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedLong() [1/2]

ulong? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedLong ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedLong() [2/2]

ulong Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedLong ( IProtonBuffer  buffer, IDecoderState  state, ulong  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedShort() [1/2]

ushort? Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedShort ( IProtonBuffer  buffer, IDecoderState  state  )

inline

Reads the encoded value from the given byte buffer and returns it. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

ReadUnsignedShort() [2/2]

ushort Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.ReadUnsignedShort ( IProtonBuffer  buffer, IDecoderState  state, ushort  defaultValue  )

inline

Reads the encoded value from the given byte buffer and returns it or the default if the encoding type is null. If the next value in the byte stream is not of the requested type an error is thrown. If the caller wishes to recover from errors due to unexpected types the byte stream should be marked and reset in order to make additional read attempts.

Parameters

buffer	The buffer to read the encoded value from
state	A decoder state instance to use when decoding
defaultValue	The default value to return for null encodings

Returns

The decoded object or null if the encoding was null.

Exceptions

DecodeException

If an error occurs during the decode operation

Implements Apache.Qpid.Proton.Codec.IDecoder.

RegisterDescribedTypeDecoder()

IDecoder Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.RegisterDescribedTypeDecoder ( IDescribedTypeDecoder  decoder )

inline

Allows for a custom described type decoder to be registered with this decoder instance for use when decoding AMQP described types from incoming byte streams.

Template Parameters

V	Type that the decoder manages

Parameters

decoder

A described type decoder to register

Returns

This IDecoder instance.

Implements Apache.Qpid.Proton.Codec.IDecoder.

Property Documentation

CachedDecoderState

IDecoderState Apache.Qpid.Proton.Codec.Decoders.ProtonDecoder.CachedDecoderState

get

Returns a cached decoder state instance that can be used be single threaded readers that use this decoder instance.

Returns

A cached decoder state object that can be used by single threaded readers

Implements Apache.Qpid.Proton.Codec.IDecoder.

---

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

• src/Proton/Codec/Decoders/ProtonDecoder.cs