Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Buffering.MessageByteBuffer Class Reference

Custom byte buffer for Diffusion-type messages. More...

Inheritance diagram for PushTechnology.DiffusionCore.Buffering.MessageByteBuffer:
PushTechnology.DiffusionCore.Buffering.ByteBuffer PushTechnology.DiffusionCore.Buffering.ByteBufferBase

Public Member Functions

 MessageByteBuffer ()
 Constructor. More...
 
 MessageByteBuffer (int desiredSize)
 Constructor. More...
 
 MessageByteBuffer (byte[] buffer, bool setPosition, bool autoExpand)
 Constructor. More...
 
void AppendFieldDelimiter ()
 Appends a field delimiter to the byte array at the current position. More...
 
void AppendRecordDelimiter ()
 Appends a record delimiter to the byte array at the current position. More...
 
void AppendMessageDelimiter ()
 Appends a message delimiter to the byte array at the current position. More...
 
- Public Member Functions inherited from PushTechnology.DiffusionCore.Buffering.ByteBuffer
 ByteBuffer ()
 Constructor. More...
 
 ByteBuffer (bool autoExpand)
 Constructor. More...
 
 ByteBuffer (int desiredSize)
 Constructor. More...
 
 ByteBuffer (int desiredSize, bool autoExpand)
 Constructor. More...
 
 ByteBuffer (byte[] buffer)
 Constructs a new ByteBuffer object without incrementing the position. More...
 
 ByteBuffer (byte[] buffer, bool setPosition, bool autoExpand)
 Constructor. More...
 
 ByteBuffer (ByteBuffer buffer)
 Creates a ByteBuffer from a source ByteBuffer. More...
 
 ByteBuffer (byte[] buffer, int desiredSize)
 Creates a ByteBuffer from an array of bytes of the desired size. Note: does not increment the current position. More...
 
 ByteBuffer (object expand)
 Constructor. More...
 
override string ToString ()
 
ByteBuffer GetRemainder ()
 Returns the remaining bytes in this buffer as a new buffer. It would be prudent to call 'HasRemaining' prior to calling this. More...
 
string ToHexString ()
 Return a string summarizing the state of this buffer. More...
 
string ToDecimalString ()
 Returns a string representing the decimal values of this ByteBuffer. More...
 
bool Contains (byte byteToFind)
 Helper method to scan the byte array for a particular byte. More...
 
ByteBuffer AsReadOnlyBuffer ()
 Creates a readonly version of the current byte buffer. More...
 
- Public Member Functions inherited from PushTechnology.DiffusionCore.Buffering.ByteBufferBase
virtual void Acquire ()
 
ByteBufferBase Clear ()
 Resets the limit to the length and sets the position to zero. More...
 
ByteBufferBase Compact ()
 Compact this buffer. More...
 
ByteBufferBase Expand (int expectedRemaining)
 Expand the buffer. More...
 
ByteBufferBase Expand (int position, int expectedRemaining)
 Expand the buffer. More...
 
ByteBufferBase Flip ()
 Sets the limit to the position, and sets the position to 0. More...
 
byte Get ()
 Gets the byte from the current position. More...
 
byte Get (int position)
 Gets the byte at a given position. More...
 
void Get (byte[] buffer)
 Gets the buffer. More...
 
void Get (byte[] buffer, int offset, int length)
 Gets the buffer. More...
 
void Get (int position, byte[] buffer, int offset, int length)
 Gets the buffer. More...
 
void Get (int position, ByteBuffer buffer, int offset, int length)
 Gets the buffer. More...
 
char GetChar ()
 Gets a character at the current position. More...
 
char GetChar (int position)
 Gets a character at a given position. More...
 
string GetHexDump ()
 Gets a hexadecimal dump of this buffer. More...
 
short GetInt16 ()
 Gets a short at the current position. More...
 
short GetInt16 (int position)
 Gets a short at a given position. More...
 
int GetInt32 ()
 Gets a uint32 at the current position. More...
 
int GetInt32 (int position)
 Gets a uint32 at a given position. More...
 
long GetInt64 ()
 Gets a uint64 at the current position. More...
 
long GetInt64 (int position)
 Gets a uint64 at a given position. More...
 
sbyte GetSByte ()
 
sbyte GetSByte (int position)
 
ushort GetUInt16 ()
 
ushort GetUInt16 (int position)
 
uint GetUInt32 ()
 
uint GetUInt32 (int position)
 
ulong GetUInt64 ()
 
ulong GetUInt64 (int position)
 
ByteBufferBase Put (params byte[] data)
 
ByteBufferBase PutRange (byte[] data)
 
ByteBufferBase PutRange (byte[] data, bool incrementPosition)
 
ByteBufferBase Put (ByteBufferBase data)
 
ByteBufferBase Put (byte value)
 
ByteBufferBase Put (char value)
 
ByteBufferBase PutUtf8 (string str)
 
ByteBufferBase Put (short value)
 
ByteBufferBase Put (int value)
 
ByteBufferBase Put (long value)
 
ByteBufferBase Put (sbyte value)
 
ByteBufferBase Put (ushort value)
 
ByteBufferBase Put (uint value)
 
ByteBufferBase Put (ulong value)
 
ByteBufferBase Put (byte[] buffer, bool incrementPosition)
 
ByteBufferBase Put (int position, ByteBufferBase data)
 
ByteBufferBase Put (int position, byte value)
 
ByteBufferBase Put (int position, char value)
 
ByteBufferBase Put (int position, short value)
 
ByteBufferBase Put (int position, int value)
 
ByteBufferBase Put (int position, long value)
 
ByteBufferBase Put (int position, sbyte value)
 
ByteBufferBase Put (int position, ushort value)
 
ByteBufferBase Put (int position, uint value)
 
ByteBufferBase Put (int position, ulong value)
 
ByteBufferBase Put (byte[] buffer, int offset, int length, bool incrementPosition=true)
 
ByteBufferBase Put (int position, byte[] buffer, int offset, int length)
 
virtual void Release ()
 
ByteBufferBase Rewind ()
 
ByteBufferBase Skip (int numBytes)
 
ByteBufferBase Slice ()
 
override string ToString ()
 

Additional Inherited Members

- Static Public Member Functions inherited from PushTechnology.DiffusionCore.Buffering.ByteBuffer
static ByteBuffer Allocate (int capacity)
 Allocate memory for a buffer. More...
 
static ByteBuffer Wrap (byte[] buffer, bool setPosition=false, bool autoExpand=false)
 
- Static Public Member Functions inherited from PushTechnology.DiffusionCore.Buffering.ByteBufferBase
static void SetAllocator (IByteBufferAllocator allocator)
 
- Protected Member Functions inherited from PushTechnology.DiffusionCore.Buffering.ByteBuffer
override void DoCompact ()
 
override byte DoReadByte (int position)
 
override void DoReadBytes (int position, byte[] dest, int offset, int length)
 
override void DoResize (int newSize)
 
override void DoWrite (int position, byte value)
 
override void DoWrite (int position, byte[] src, int offset, int length)
 
- Static Protected Attributes inherited from PushTechnology.DiffusionCore.Buffering.ByteBufferBase
static IByteBufferAllocator THE_ALLOCATOR = new ByteBufferAllocator()
 The byte buffer allocator. More...
 
- Properties inherited from PushTechnology.DiffusionCore.Buffering.ByteBuffer
byte this[int index] [get]
 Returns a byte at the given index. More...
 
override byte[] Bytes [get]
 
override int Length [get]
 
override int Capacity [get]
 
- Properties inherited from PushTechnology.DiffusionCore.Buffering.ByteBufferBase
abstract byte[] Bytes [get]
 Get the bytes in the buffer. More...
 
abstract int Length [get]
 Get the number of bytes in the buffer. More...
 
abstract int Capacity [get]
 Get the capacity of the buffer. More...
 
bool HasRemaining [get]
 Do we have any bytes remaining? More...
 
bool IsAutoExpand [get, set]
 Is this an auto-expanding buffer? More...
 
int Limit [get, set]
 Get/set the limit of the buffer. More...
 
int Position [get, set]
 Get/set the currently indexed position into the buffer. More...
 
int Remaining [get]
 Returns how many bytes are remaining in the buffer. More...
 

Detailed Description

Custom byte buffer for Diffusion-type messages.

Constructor & Destructor Documentation

PushTechnology.DiffusionCore.Buffering.MessageByteBuffer.MessageByteBuffer ( )

Constructor.

PushTechnology.DiffusionCore.Buffering.MessageByteBuffer.MessageByteBuffer ( int  desiredSize)

Constructor.

Parameters
desiredSize
PushTechnology.DiffusionCore.Buffering.MessageByteBuffer.MessageByteBuffer ( byte[]  buffer,
bool  setPosition,
bool  autoExpand 
)

Constructor.

Parameters
buffer
setPosition
autoExpand

Member Function Documentation

void PushTechnology.DiffusionCore.Buffering.MessageByteBuffer.AppendFieldDelimiter ( )

Appends a field delimiter to the byte array at the current position.

void PushTechnology.DiffusionCore.Buffering.MessageByteBuffer.AppendMessageDelimiter ( )

Appends a message delimiter to the byte array at the current position.

void PushTechnology.DiffusionCore.Buffering.MessageByteBuffer.AppendRecordDelimiter ( )

Appends a record delimiter to the byte array at the current position.