Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer Interface Reference

A composite buffer is used to make a collection of other proton buffer instances appear as one cohesive buffer which allows the user to remain ignorant of the underlying buffer structure and in most cases does not require any special handling by the user. More...

Inheritance diagram for Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer:

Public Member Functions
IProtonCompositeBuffer	Append (IProtonBuffer extension)
	Appends the provided buffer to the end of the list of composite buffers already managed by this buffer. The given buffer becomes the property of the composite and the constraints placed upon buffers managed by the composite implementation are extended to this appended buffer. More...
IEnumerable< IProtonBuffer >	DecomposeBuffer ()
	Serves as a means of breaking up a composite buffer into an enumeration of the constituent buffers that is manages. Decomposing a buffer serves to consume the buffer leaving it an empty state, and the returned buffers are considered the property of the caller. More...
Public Member Functions inherited from Apache.Qpid.Proton.Buffer.IProtonBuffer
IProtonBuffer	Fill (byte value)
	Fill the buffer with the given byte value. This method does not respect the read offset nor the write offset but instead fills the entire backing buffer memory with the given value. More...
IProtonBuffer	EnsureWritable (long amount)
	Requests that the buffer ensure that there is enough allocated internal capacity such that the given number of bytes can be written without requiring additional allocations and that this amount does not exceed any total capacity restrictions for this buffer. More...
IProtonBuffer	Reset ()
	Resets the read and write offset values to zero. More...
IProtonBuffer	CopyInto (long srcPos, byte[] dest, long destPos, long length)
	Copies the given number of bytes from this buffer into the target byte buffer starting the read from the given position in this buffer and the write to at the given position in the destination buffer. The length parameter controls how many bytes are copied to the destination. This method does not modify the read or write offset values in this buffer. More...
IProtonBuffer	CopyInto (long srcPos, IProtonBuffer dest, long destPos, long length)
	Copies the given number of bytes from this buffer into the target byte buffer starting the read from the given position in this buffer and the write to at the given position in the destination buffer. The length parameter controls how many bytes are copied to the destination. This method does not modify the read or write offset values in this buffer nor those of the destination buffer. The destination write index is an absolute index value unrelated to the write offset of the target. More...
IProtonBuffer	Copy ()
	Returns a copy of this buffer's readable bytes. Modifying the content of the returned buffer will not affect this buffers contents. The two buffers will maintain separate offsets. The returned copy has the write offset set to the length of the copy meaning that the entire copied region is read for reading. More...
IProtonBuffer	Copy (long index, long length)
	Returns a copy of this buffer's readable bytes. Modifying the content of the returned buffer will not affect this buffers contents. The two buffers will maintain separate offsets. The amount and start of the data to be copied is provided by the index and length arguments. The returned copy has the write offset set to the length of the copy meaning that the entire copied region is read for reading. More...
string	ToString (Encoding encoding)
	Coverts the readable bytes in this buffer into a string value using the Encoding value provided. The underlying read and write offset values are not modified as a result of this operation. More...
IProtonBuffer	SkipBytes (long amount)
	Advance the buffer read offset by the specified amount effectively skipping that number of bytes from being read. More...
IProtonBuffer	WriteBytes (byte[] source)
	Writes the contents of the given byte array into this buffer and advances the write offset by the number of bytes written. More...
IProtonBuffer	WriteBytes (byte[] source, long offset, long length)
	Writes the contents of the given byte array into this buffer and advances the write offset by the number of bytes written. More...
IProtonBuffer	WriteBytes (IProtonBuffer source)
	Transfers the bytes from the source buffer to this buffer starting at the current write offset and continues until the source buffer becomes unreadable. The write index of this buffer is increased by the number of bytes read from the source. The method also increases the read offset of the source by the same amount as was written. More...
IProtonBuffer	Compact ()
	Discards the read bytes, and moves the buffer contents to the beginning of the buffer. More...
IProtonBuffer	Reclaim ()
	Reclaims read buffer space and returns it to the operating system or other pooling mechanisms if those are in place, then compacts the remaining buffer contents. For a non-composite buffer this operation could consist of allocating a smaller buffer to house any remaining unread bytes and freeing the larger backing buffer in some cases or it may result in a no-op depending on the buffer implementation. For the composite buffer case this operation provides an API which allows for fully read buffer constituents to be released and returned to a memory pool or back to the O/S. More...
IProtonBuffer	ReadSplit (long offset)
	Splits the buffer into two distinct buffers at the given index plus the current read offset. The returned buffer will retain the read offset and write offset of this buffer but will be truncated to match the capacity provided by the split index, which implies that they might both be set to the capacity if they were previously set beyond the split index. The returned buffer will set its read and write offsets to zero if they fell prior to the given index otherwise they will be truncated to match the new buffer capacity. Split buffers support the standard buffer operations including resizing to ensure writable regions which implies that a buffer resize on either will cause them to no longer reference the same underlying memory region. If buffer implementations implement pooling then they must ensure proper release of shared buffer regions once both buffers no longer reference them. More...
IProtonBuffer	WriteSplit (long offset)
	Splits the buffer into two distinct buffers at the given index plus the current write offset. The returned buffer will retain the read offset and write offset of this buffer but will be truncated to match the capacity provided by the split index, which implies that they might both be set to the capacity if they were previously set to the split index. The returned buffer will set its read and write offsets to zero if they fell prior to the given index otherwise they will be truncated to match the new buffer capacity. Split buffers support the standard buffer operations including resizing to ensure writable regions which implies that a buffer resize on either will cause them to no longer reference the same underlying memory region. If buffer implementations implement pooling then they must ensure proper release of shared buffer regions once both buffers no longer reference them. More...
IProtonBuffer	Split ()
	Splits the buffer into two buffers at the write offset. The resulting buffer will comprise the read and readable portions of this buffer with the write offset and capacity set to the current write offset. This buffer will lose access to the split region and its read offset will be set to the current write offset. This buffer will also have its capacity reduced by the number of bytes in the returned buffer (i.e. the current number of read and readable bytes). Split buffers support the standard buffer operations including resizing to ensure writable regions which implies that a buffer resize on either will cause them to no longer reference the same underlying memory region. If buffer implementations implement pooling then they must ensure proper release of shared buffer regions once both buffers no longer reference them. More...
IProtonBuffer	Split (long index)
	Splits the buffer into two distinct buffers at the given index. The returned buffer will retain the read offset and write offset of this buffer but will be truncated to match the capacity provided by the split index, which implies that they might both be set to the capacity if they were previously set beyond the split index. The returned buffer will set its read and write offsets to zero if they fell prior to the given index otherwise they will be truncated to match the new buffer capacity. Split buffers support the standard buffer operations including resizing to ensure writable regions which implies that a buffer resize on either will cause them to no longer reference the same underlying memory region. If buffer implementations implement pooling then they must ensure proper release of shared buffer regions once both buffers no longer reference them. More...
int	ForEachReadableComponent (in int index, in Func< int, IReadableComponent, bool > processor)
	Invokes the provided delegate for each readable component in this buffer and increments the provided index value for each invocation. The total number of buffers processed is returned to the caller. The delegate can stop processing at any time by returning false in which case this method will stop and return a negative value to indicate that processing stopped early and did not traverse all available components. More...
int	ForEachWritableComponent (in int index, in Func< int, IWritableComponent, bool > processor)
	Invokes the provided delegate for each writable component in this buffer and increments the provided index value for each invocation. The total number of buffers processed is returned to the caller. The delegate can stop processing at any time by returning false in which case this method will stop and return a negative value to indicate that processing stopped early and did not traverse all available components. More...
Public Member Functions inherited from Apache.Qpid.Proton.Buffer.IProtonBufferAccessors
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). More...
sbyte	GetByte (long index)
	Reads a single signed byte from the given index and returns it. More...
byte	GetUnsignedByte (long index)
	Reads a single unsigned byte from the given index and returns it. More...
char	GetChar (long index)
	Reads a single 2 byte char from the given index and returns it. More...
short	GetShort (long index)
	Reads a single 2 byte short from the given index and returns it. More...
ushort	GetUnsignedShort (long index)
	Reads a single 2 byte unsigned short from the given index and returns it. More...
int	GetInt (long index)
	Reads a single 4 byte int from the given index and returns it. More...
uint	GetUnsignedInt (long index)
	Reads a single 4 byte unsigned int from the given index and returns it. More...
long	GetLong (long index)
	Reads a single 8 byte long from the given index and returns it. More...
ulong	GetUnsignedLong (long index)
	Reads a single 8 byte unsigned long from the given index and returns it. More...
float	GetFloat (long index)
	Reads a single 4 byte float from the given index and returns it. More...
double	GetDouble (long index)
	Reads a single 8 byte double from the given index and returns it. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
sbyte	ReadByte ()
	Read a signed byte from the buffer and advance the read offset. More...
byte	ReadUnsignedByte ()
	Read a unsigned byte from the buffer and advance the read offset. More...
bool	ReadBoolean ()
	Reads the next byte from the buffer and returns the boolean value. More...
char	ReadChar ()
	Reads the two bytes from the buffer and returns the char value. More...
short	ReadShort ()
	Reads the next two bytes from the buffer and returns the short value. More...
ushort	ReadUnsignedShort ()
	Reads the next two bytes from the buffer and returns the unsigned short value. More...
int	ReadInt ()
	Reads the next four bytes from the buffer and returns the int value. More...
uint	ReadUnsignedInt ()
	Reads the next four bytes from the buffer and returns the unsigned int value. More...
long	ReadLong ()
	Reads the next eight bytes from the buffer and returns the long value. More...
ulong	ReadUnsignedLong ()
	Reads the next eight bytes from the buffer and returns the unsigned long value. More...
float	ReadFloat ()
	Reads the next four bytes from the buffer and returns the float value. More...
double	ReadDouble ()
	Reads the next eight bytes from the buffer and returns the double value. More...
IProtonBuffer	WriteByte (sbyte value)
	Writes the given byte value into this buffer and increases the write offset. More...
IProtonBuffer	WriteUnsignedByte (byte value)
	Writes the given unsigned byte value into this buffer and increases the write offset. More...
IProtonBuffer	WriteBoolean (bool value)
	Writes the given boolean value into this buffer as a single byte and increases the write offset. More...
IProtonBuffer	WriteShort (short value)
	Writes the given two byte short value into this buffer and increases the write offset. More...
IProtonBuffer	WriteUnsignedShort (ushort value)
	Writes the given two byte unsigned short value into this buffer and increases the write offset. More...
IProtonBuffer	WriteInt (int value)
	Writes the given four byte int value into this buffer and increases the write offset. More...
IProtonBuffer	WriteUnsignedInt (uint value)
	Writes the given four byte unsigned int value into this buffer and increases the write offset. More...
IProtonBuffer	WriteLong (long value)
	Writes the given eight byte long value into this buffer and increases the write offset. More...
IProtonBuffer	WriteUnsignedLong (ulong value)
	Writes the given eight byte unsigned long value into this buffer and increases the write offset. More...
IProtonBuffer	WriteFloat (float value)
	Writes the given four byte float value into this buffer and increases the write offset. More...
IProtonBuffer	WriteDouble (double value)
	Writes the given eight byte double value into this buffer and increases the write offset. More...

Static Public Member Functions
static IProtonCompositeBuffer	Compose ()
	Creates a new empty composite buffer instance that can be extended with additional buffers or used directly to write initial data at which point the provided allocator will be used to create a buffer instance. At any point should the composite buffer need to allocate a new buffer in order to accommodate buffer writes a default buffer allocator will be used. More...
static IProtonCompositeBuffer	Compose (long maxCapacity)
	Creates a new empty composite buffer instance that can be extended with additional buffers or used directly to write initial data at which point the provided allocator will be used to create a buffer instance. At any point should the composite buffer need to allocate a new buffer in order to accommodate buffer writes a default buffer allocator will be used. More...
static IProtonCompositeBuffer	Compose (IProtonBufferAllocator allocator)
	Creates a new empty composite buffer instance that can be extended with additional buffers or used directly to write initial data at which point the provided allocator will be used to create a buffer instance. At any point should the composite buffer need to allocate a new buffer in order to accommodate buffer writes the provided allocator will be used. More...
static IProtonCompositeBuffer	Compose (IProtonBufferAllocator allocator, IEnumerable< IProtonBuffer > buffers)
	Creates a new composite buffer that is composed of the given enumeration of buffers. More...
static IProtonCompositeBuffer	Compose (IProtonBufferAllocator allocator, params IProtonBuffer[] buffers)
	Creates a new composite buffer that is composed of the given enumeration of buffers. More...
static IProtonCompositeBuffer	Compose (params IProtonBuffer[] buffers)
	Creates a new composite buffer that is composed of the given enumeration of buffers. More...
static IProtonCompositeBuffer	Compose (IEnumerable< IProtonBuffer > buffers)
	Creates a new composite buffer that is composed of the given enumeration of buffers. More...
static bool	IsComposite (IProtonBuffer buffer)
	Simpler helper API for user to check if a given buffer is indeed a composite buffer instance. More...

Additional Inherited Members
Properties inherited from Apache.Qpid.Proton.Buffer.IProtonBuffer
long	Capacity [get]
	Gets the current capacity of this buffer instance which is the total amount of bytes that could be written before additional buffer capacity would be needed to allow more buffer writes. The remaining amount of writable bytes at any given time is the buffer capacity minus the write offset. More...
bool	IsReadable [get]
	Returns true if the current read offset is less than the current write offset meaning there are bytes available for reading. More...
long	ReadableBytes [get]
	Returns the number of bytes that can currently be read from this buffer. More...
bool	IsWritable [get]
	Returns true if write offset is less than the current buffer capacity limit. More...
long	WritableBytes [get]
	Returns the number of bytes that can currently be written from this buffer. More...
long	ReadOffset [get, set]
	Gets or sets the current read offset in this buffer. If the read offset is set to a value larger than the current write offset an exception is thrown. More...
long	WriteOffset [get, set]
	Gets or sets the current write offset in this buffer. If the write offset is set to a value less than the current read offset or larger than the current buffer capacity an exception is thrown. More...
uint	ComponentCount [get]
	Returns the number of component buffers in this buffer. If this is not a composite buffer instance then the count will always be one. For a composite buffer this will be the count of the current number of component buffers contained within. More...
uint	ReadableComponentCount [get]
	Returns the number of component buffers in this buffer that are readable and would be provided to calls to the for each readable buffer API. If this is not a composite buffer instance then the count will be at most one. For a composite buffer this will be the count of the current number of component buffers contained within that are readable. More...
uint	WritableComponentCount [get]
	Returns the number of component buffers in this buffer that are writable and would be provided to calls to the for each writable buffer API. If this is not a composite buffer instance then the count will be at most one. For a composite buffer this will be the count of the current number of component buffers contained within that are writable. More...
Properties inherited from Apache.Qpid.Proton.Buffer.IProtonBufferAccessors
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. More...

Detailed Description

A composite buffer is used to make a collection of other proton buffer instances appear as one cohesive buffer which allows the user to remain ignorant of the underlying buffer structure and in most cases does not require any special handling by the user.

Member Function Documentation

Append()

IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Append

(

IProtonBuffer

extension

)

Appends the provided buffer to the end of the list of composite buffers already managed by this buffer. The given buffer becomes the property of the composite and the constraints placed upon buffers managed by the composite implementation are extended to this appended buffer.

Parameters

extension

The buffer to append to the end of the composite set

Returns

This composite buffer instance.

Implemented in Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

Compose() [1/7]

static IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Compose ( )

inlinestatic

Creates a new empty composite buffer instance that can be extended with additional buffers or used directly to write initial data at which point the provided allocator will be used to create a buffer instance. At any point should the composite buffer need to allocate a new buffer in order to accommodate buffer writes a default buffer allocator will be used.

Returns

a new empty composite buffer instance.

Exceptions

NotImplementedException

Compose() [2/7]

static IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Compose ( IEnumerable< IProtonBuffer >  buffers )

inlinestatic

Creates a new composite buffer that is composed of the given enumeration of buffers.

The provided buffers must adhere to the buffer consistency guidelines of the buffer implementation that is used to create the composite buffer, if they do not an exception may be thrown that indicates the nature of the violation.

Parameters

buffers

The enumeration of buffers to compose the new composite

Returns

a new empty composite buffer instance.

Compose() [3/7]

static IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Compose ( IProtonBufferAllocator  allocator )

inlinestatic

Creates a new empty composite buffer instance that can be extended with additional buffers or used directly to write initial data at which point the provided allocator will be used to create a buffer instance. At any point should the composite buffer need to allocate a new buffer in order to accommodate buffer writes the provided allocator will be used.

Parameters

allocator

A buffer allocator that the composite should use

Returns

a new empty composite buffer instance.

Exceptions

NotImplementedException

Compose() [4/7]

static IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Compose ( IProtonBufferAllocator  allocator, IEnumerable< IProtonBuffer >  buffers  )

inlinestatic

Creates a new composite buffer that is composed of the given enumeration of buffers.

The provided buffers must adhere to the buffer consistency guidelines of the buffer implementation that is used to create the composite buffer, if they do not an exception may be thrown that indicates the nature of the violation.

Parameters

allocator	A buffer allocator that the composite should use
buffers	The enumeration of buffers to compose the new composite

Returns

a new empty composite buffer instance.

Compose() [5/7]

static IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Compose ( IProtonBufferAllocator  allocator, params IProtonBuffer[]  buffers  )

inlinestatic

Creates a new composite buffer that is composed of the given enumeration of buffers.

The provided buffers must adhere to the buffer consistency guidelines of the buffer implementation that is used to create the composite buffer, if they do not an exception may be thrown that indicates the nature of the violation.

Parameters

allocator	A buffer allocator that the composite should use
buffers	The enumeration of buffers to compose the new composite

Returns

a new empty composite buffer instance.

Compose() [6/7]

static IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Compose ( long  maxCapacity )

inlinestatic

Creates a new empty composite buffer instance that can be extended with additional buffers or used directly to write initial data at which point the provided allocator will be used to create a buffer instance. At any point should the composite buffer need to allocate a new buffer in order to accommodate buffer writes a default buffer allocator will be used.

Parameters

maxCapacity

The maximum capacity this composite can contain

Returns

a new empty composite buffer instance.

Exceptions

NotImplementedException

Compose() [7/7]

static IProtonCompositeBuffer Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.Compose ( params IProtonBuffer[]  buffers )

inlinestatic

Creates a new composite buffer that is composed of the given enumeration of buffers.

The provided buffers must adhere to the buffer consistency guidelines of the buffer implementation that is used to create the composite buffer, if they do not an exception may be thrown that indicates the nature of the violation.

Parameters

buffers

The enumeration of buffers to compose the new composite

Returns

a new empty composite buffer instance.

DecomposeBuffer()

IEnumerable<IProtonBuffer> Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.DecomposeBuffer

(

)

Serves as a means of breaking up a composite buffer into an enumeration of the constituent buffers that is manages. Decomposing a buffer serves to consume the buffer leaving it an empty state, and the returned buffers are considered the property of the caller.

Returns

Implemented in Apache.Qpid.Proton.Buffer.ProtonCompositeBuffer.

IsComposite()

static bool Apache.Qpid.Proton.Buffer.IProtonCompositeBuffer.IsComposite ( IProtonBuffer  buffer )

inlinestatic

Simpler helper API for user to check if a given buffer is indeed a composite buffer instance.

Parameters

buffer

The buffer to check

Returns

true if the given buffer implements the composite buffer interface.

---

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

• src/Proton/Buffer/IProtonCompositeBuffer.cs