Proton DotNet
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
Apache.Qpid.Proton.Buffer.IProtonBufferAccessors Interface Reference

Interface for proton buffer primitive type accessors that can be used with custom types to extend or otherwise customize buffer access. More...

Inheritance diagram for Apache.Qpid.Proton.Buffer.IProtonBufferAccessors:
Apache.Qpid.Proton.Buffer.IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.ProtonByteBuffer Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer

Public Member Functions

bool GetBoolean (long index)
 Reads a single byte from the given index and returns a boolean value indicating if the byte was zero (false) or greater than zero (true).
 
sbyte GetByte (long index)
 Reads a single signed byte from the given index and returns it.
 
byte GetUnsignedByte (long index)
 Reads a single unsigned byte from the given index and returns it.
 
char GetChar (long index)
 Reads a single 2 byte char from the given index and returns it.
 
short GetShort (long index)
 Reads a single 2 byte short from the given index and returns it.
 
ushort GetUnsignedShort (long index)
 Reads a single 2 byte unsigned short from the given index and returns it.
 
int GetInt (long index)
 Reads a single 4 byte int from the given index and returns it.
 
uint GetUnsignedInt (long index)
 Reads a single 4 byte unsigned int from the given index and returns it.
 
long GetLong (long index)
 Reads a single 8 byte long from the given index and returns it.
 
ulong GetUnsignedLong (long index)
 Reads a single 8 byte unsigned long from the given index and returns it.
 
float GetFloat (long index)
 Reads a single 4 byte float from the given index and returns it.
 
double GetDouble (long index)
 Reads a single 8 byte double from the given index and returns it.
 
IProtonBuffer SetByte (long index, sbyte value)
 Write the given byte value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetUnsignedByte (long index, byte value)
 Write the given unsigned byte value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetBoolean (long index, bool value)
 Write the given boolean value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetChar (long index, char value)
 Write the given 2 byte char value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetShort (long index, short value)
 Write the given 2 byte short value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetUnsignedShort (long index, ushort value)
 Write the given 2 byte unsigned short value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetInt (long index, int value)
 Write the given 4 byte int value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetUnsignedInt (long index, uint value)
 Write the given 4 byte unsigned int value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetLong (long index, long value)
 Write the given 8 byte long value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetUnsignedLong (long index, ulong value)
 Write the given 8 byte unsigned long value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetFloat (long index, float value)
 Write the given 4 byte float value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
IProtonBuffer SetDouble (long index, double value)
 Write the given 8 byte double value at the given location in the buffer backing store without modifying the write offset of this buffer.
 
sbyte ReadByte ()
 Read a signed byte from the buffer and advance the read offset.
 
byte ReadUnsignedByte ()
 Read a unsigned byte from the buffer and advance the read offset.
 
bool ReadBoolean ()
 Reads the next byte from the buffer and returns the boolean value.
 
char ReadChar ()
 Reads the two bytes from the buffer and returns the char value.
 
short ReadShort ()
 Reads the next two bytes from the buffer and returns the short value.
 
ushort ReadUnsignedShort ()
 Reads the next two bytes from the buffer and returns the unsigned short value.
 
int ReadInt ()
 Reads the next four bytes from the buffer and returns the int value.
 
uint ReadUnsignedInt ()
 Reads the next four bytes from the buffer and returns the unsigned int value.
 
long ReadLong ()
 Reads the next eight bytes from the buffer and returns the long value.
 
ulong ReadUnsignedLong ()
 Reads the next eight bytes from the buffer and returns the unsigned long value.
 
float ReadFloat ()
 Reads the next four bytes from the buffer and returns the float value.
 
double ReadDouble ()
 Reads the next eight bytes from the buffer and returns the double value.
 
IProtonBuffer WriteByte (sbyte value)
 Writes the given byte value into this buffer and increases the write offset.
 
IProtonBuffer WriteUnsignedByte (byte value)
 Writes the given unsigned byte value into this buffer and increases the write offset.
 
IProtonBuffer WriteBoolean (bool value)
 Writes the given boolean value into this buffer as a single byte and increases the write offset.
 
IProtonBuffer WriteShort (short value)
 Writes the given two byte short value into this buffer and increases the write offset.
 
IProtonBuffer WriteUnsignedShort (ushort value)
 Writes the given two byte unsigned short value into this buffer and increases the write offset.
 
IProtonBuffer WriteInt (int value)
 Writes the given four byte int value into this buffer and increases the write offset.
 
IProtonBuffer WriteUnsignedInt (uint value)
 Writes the given four byte unsigned int value into this buffer and increases the write offset.
 
IProtonBuffer WriteLong (long value)
 Writes the given eight byte long value into this buffer and increases the write offset.
 
IProtonBuffer WriteUnsignedLong (ulong value)
 Writes the given eight byte unsigned long value into this buffer and increases the write offset.
 
IProtonBuffer WriteFloat (float value)
 Writes the given four byte float value into this buffer and increases the write offset.
 
IProtonBuffer WriteDouble (double value)
 Writes the given eight byte double value into this buffer and increases the write offset.
 

Properties

byte this[long i] [get, set]
 Indexed access to single unsigned byte values within the buffer which does not modify the read or write index value. The given index must adhere to the same constraints as the get byte and set byte level APIs in this buffer class.
 

Detailed Description

Interface for proton buffer primitive type accessors that can be used with custom types to extend or otherwise customize buffer access.

Member Function Documentation

◆ GetBoolean()

bool Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetBoolean ( long  index)

Reads a single byte from the given index and returns a boolean value indicating if the byte was zero (false) or greater than zero (true).

Parameters
index
Returns
the boolean value of the byte at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetByte()

sbyte Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetByte ( long  index)

Reads a single signed byte from the given index and returns it.

Parameters
index
Returns
the byte value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetChar()

char Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetChar ( long  index)

Reads a single 2 byte char from the given index and returns it.

Parameters
index
Returns
the char value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetDouble()

double Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetDouble ( long  index)

Reads a single 8 byte double from the given index and returns it.

Parameters
index
Returns
the double value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetFloat()

float Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetFloat ( long  index)

Reads a single 4 byte float from the given index and returns it.

Parameters
index
Returns
the float value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetInt()

int Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetInt ( long  index)

Reads a single 4 byte int from the given index and returns it.

Parameters
index
Returns
the int value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetLong()

long Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetLong ( long  index)

Reads a single 8 byte long from the given index and returns it.

Parameters
index
Returns
the long value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetShort()

short Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetShort ( long  index)

Reads a single 2 byte short from the given index and returns it.

Parameters
index
Returns
the short value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetUnsignedByte()

byte Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetUnsignedByte ( long  index)

Reads a single unsigned byte from the given index and returns it.

Parameters
index
Returns
the byte value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetUnsignedInt()

uint Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetUnsignedInt ( long  index)

Reads a single 4 byte unsigned int from the given index and returns it.

Parameters
index
Returns
the int value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetUnsignedLong()

ulong Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetUnsignedLong ( long  index)

Reads a single 8 byte unsigned long from the given index and returns it.

Parameters
index
Returns
the long value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ GetUnsignedShort()

ushort Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.GetUnsignedShort ( long  index)

Reads a single 2 byte unsigned short from the given index and returns it.

Parameters
index
Returns
the short value at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadBoolean()

bool Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadBoolean ( )

Reads the next byte from the buffer and returns the boolean value.

Returns
the boolean value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadByte()

sbyte Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadByte ( )

Read a signed byte from the buffer and advance the read offset.

Returns
The value read from the buffer
Exceptions
IndexOutOfRangeExceptionIf the buffer has no more readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadChar()

char Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadChar ( )

Reads the two bytes from the buffer and returns the char value.

Returns
the char value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadDouble()

double Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadDouble ( )

Reads the next eight bytes from the buffer and returns the double value.

Returns
the double value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadFloat()

float Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadFloat ( )

Reads the next four bytes from the buffer and returns the float value.

Returns
the float value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadInt()

int Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadInt ( )

Reads the next four bytes from the buffer and returns the int value.

Returns
the int value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadLong()

long Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadLong ( )

Reads the next eight bytes from the buffer and returns the long value.

Returns
the long value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadShort()

short Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadShort ( )

Reads the next two bytes from the buffer and returns the short value.

Returns
the short value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadUnsignedByte()

byte Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadUnsignedByte ( )

Read a unsigned byte from the buffer and advance the read offset.

Returns
The value read from the buffer
Exceptions
IndexOutOfRangeExceptionIf the buffer has no more readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadUnsignedInt()

uint Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadUnsignedInt ( )

Reads the next four bytes from the buffer and returns the unsigned int value.

Returns
the unsigned int value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadUnsignedLong()

ulong Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadUnsignedLong ( )

Reads the next eight bytes from the buffer and returns the unsigned long value.

Returns
the unsigned long value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ ReadUnsignedShort()

ushort Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.ReadUnsignedShort ( )

Reads the next two bytes from the buffer and returns the unsigned short value.

Returns
the unsigned short value at the given index
Exceptions
IndexOutOfRangeExceptionIf there are not enough readable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetBoolean()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetBoolean ( long  index,
bool  value 
)

Write the given boolean value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetByte()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetByte ( long  index,
sbyte  value 
)

Write the given byte value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetChar()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetChar ( long  index,
char  value 
)

Write the given 2 byte char value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetDouble()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetDouble ( long  index,
double  value 
)

Write the given 8 byte double value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetFloat()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetFloat ( long  index,
float  value 
)

Write the given 4 byte float value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetInt()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetInt ( long  index,
int  value 
)

Write the given 4 byte int value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetLong()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetLong ( long  index,
long  value 
)

Write the given 8 byte long value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetShort()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetShort ( long  index,
short  value 
)

Write the given 2 byte short value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetUnsignedByte()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetUnsignedByte ( long  index,
byte  value 
)

Write the given unsigned byte value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetUnsignedInt()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetUnsignedInt ( long  index,
uint  value 
)

Write the given 4 byte unsigned int value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetUnsignedLong()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetUnsignedLong ( long  index,
ulong  value 
)

Write the given 8 byte unsigned long value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ SetUnsignedShort()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.SetUnsignedShort ( long  index,
ushort  value 
)

Write the given 2 byte unsigned short value at the given location in the buffer backing store without modifying the write offset of this buffer.

Parameters
indexThe index in the buffer where the write should occur
valueThe value to be written at the specified index
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteBoolean()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteBoolean ( bool  value)

Writes the given boolean value into this buffer as a single byte and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteByte()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteByte ( sbyte  value)

Writes the given byte value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteDouble()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteDouble ( double  value)

Writes the given eight byte double value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteFloat()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteFloat ( float  value)

Writes the given four byte float value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteInt()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteInt ( int  value)

Writes the given four byte int value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteLong()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteLong ( long  value)

Writes the given eight byte long value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteShort()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteShort ( short  value)

Writes the given two byte short value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteUnsignedByte()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteUnsignedByte ( byte  value)

Writes the given unsigned byte value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteUnsignedInt()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteUnsignedInt ( uint  value)

Writes the given four byte unsigned int value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteUnsignedLong()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteUnsignedLong ( ulong  value)

Writes the given eight byte unsigned long value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

◆ WriteUnsignedShort()

IProtonBuffer Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.WriteUnsignedShort ( ushort  value)

Writes the given two byte unsigned short value into this buffer and increases the write offset.

Parameters
valueThe value to write into this buffer
Returns
this buffer instance
Exceptions
IndexOutOfRangeExceptionIf there are not enough writable bytes

Implemented in Apache.Qpid.Proton.Buffer.ProtonByteBuffer, and Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

Property Documentation

◆ this[long i]

byte Apache.Qpid.Proton.Buffer.IProtonBufferAccessors.this[long i]
getset

Indexed access to single unsigned byte values within the buffer which does not modify the read or write index value. The given index must adhere to the same constraints as the get byte and set byte level APIs in this buffer class.

Parameters
i
Returns
The unsigned byte value that is present at the given index
Exceptions
IndexOutOfRangeExceptionIf the index is negative or larger than buffer capacity

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