GemStone::GemFire::Cache::DataInput Class Reference


Detailed Description

Provides operations for reading primitive data values, byte arrays, strings, IGFSerializable objects from a byte stream.

Public Member Functions

 !DataInput ()
void AdvanceCursor (int32_t offset)
 DataInput (array< Byte >^buffer, int32_t len)
 DataInput (array< Byte >^buffer)
int ReadArrayLen ()
String^ ReadASCIIHuge ()
bool ReadBoolean ()
Byte ReadByte ()
array< Byte >^ ReadBytes ()
array< Byte >^ ReadBytesOnly (uint32_t len)
double ReadDouble ()
float ReadFloat ()
int16_t ReadInt16 ()
int32_t ReadInt32 ()
int64_t ReadInt64 ()
IGFSerializableReadObject ()
SByte ReadSByte ()
array< SByte >^ ReadSBytes ()
array< SByte >^ ReadSBytesOnly (uint32_t len)
uint16_t ReadUInt16 ()
uint32_t ReadUInt32 ()
uint64_t ReadUInt64 ()
String^ ReadUTF ()
String^ ReadUTFHuge ()
void Reset ()
void RewindCursor (int32_t offset)
 ~DataInput ()

Properties

uint32_t BytesRead [get]
uint32_t BytesRemaining [get]
IntPtr NativeIntPtr [get]

Constructor & Destructor Documentation

GemStone::GemFire::Cache::DataInput::DataInput ( array< Byte >^  buffer  ) 

Construct DataInput using an given array of bytes.

Parameters:
buffer The buffer to use for reading data values.
Exceptions:
IllegalArgumentException if the buffer is null

GemStone::GemFire::Cache::DataInput::DataInput ( array< Byte >^  buffer,
int32_t  len 
)

Construct DataInput using a given length of an array of bytes.

Parameters:
buffer The buffer to use for reading data values.
len The number of bytes from the start of the buffer to use.
Exceptions:
IllegalArgumentException if the buffer is null

GemStone::GemFire::Cache::DataInput::~DataInput (  )  [inline]

Dispose: frees the internal buffer.

GemStone::GemFire::Cache::DataInput::!DataInput (  )  [inline]

Finalizer: frees the internal buffer.


Member Function Documentation

void GemStone::GemFire::Cache::DataInput::AdvanceCursor ( int32_t  offset  ) 

Advance the cursor of the buffer by the given offset.

Parameters:
offset The offset(number of bytes) by which to advance the cursor.

int GemStone::GemFire::Cache::DataInput::ReadArrayLen (  ) 

Read a array len based on array size.

String ^ GemStone::GemFire::Cache::DataInput::ReadASCIIHuge (  ) 

Read a ASCII string from the stream. Where size is more than 2^16-1

bool GemStone::GemFire::Cache::DataInput::ReadBoolean (  ) 

Read a boolean value from the stream.

Byte GemStone::GemFire::Cache::DataInput::ReadByte (  ) 

Read a byte from the stream.

array<Byte> ^ GemStone::GemFire::Cache::DataInput::ReadBytes (  ) 

Read an array of bytes from the stream reading the length from the stream first.

array<Byte> ^ GemStone::GemFire::Cache::DataInput::ReadBytesOnly ( uint32_t  len  ) 

Read the given number of bytes from the stream.

Parameters:
len Number of bytes to read.

double GemStone::GemFire::Cache::DataInput::ReadDouble (  ) 

Read a double precision number from the stream.

float GemStone::GemFire::Cache::DataInput::ReadFloat (  ) 

Read a floating point number from the stream.

int16_t GemStone::GemFire::Cache::DataInput::ReadInt16 (  ) 

Read a 16-bit integer from the stream.

int32_t GemStone::GemFire::Cache::DataInput::ReadInt32 (  ) 

Read a 32-bit integer from the stream.

int64_t GemStone::GemFire::Cache::DataInput::ReadInt64 (  ) 

Read a 64-bit integer from the stream.

IGFSerializable ^ GemStone::GemFire::Cache::DataInput::ReadObject (  ) 

Read a serializable object from the data. Null objects are handled.

SByte GemStone::GemFire::Cache::DataInput::ReadSByte (  ) 

Read a signed byte from the stream.

array<SByte> ^ GemStone::GemFire::Cache::DataInput::ReadSBytes (  ) 

Read an array of signed bytes from the stream reading the length from the stream first.

array<SByte> ^ GemStone::GemFire::Cache::DataInput::ReadSBytesOnly ( uint32_t  len  ) 

Read the given number of signed bytes from the stream.

Parameters:
len Number of signed bytes to read.

uint16_t GemStone::GemFire::Cache::DataInput::ReadUInt16 (  ) 

Read a 16-bit unsigned integer from the stream.

uint32_t GemStone::GemFire::Cache::DataInput::ReadUInt32 (  ) 

Read a 32-bit unsigned integer from the stream.

uint64_t GemStone::GemFire::Cache::DataInput::ReadUInt64 (  ) 

Read a 64-bit unsigned integer from the stream.

String ^ GemStone::GemFire::Cache::DataInput::ReadUTF (  ) 

Read a string after java-modified UTF-8 decoding from the stream. The maximum length supported is 2^16-1 beyond which the string shall be truncated.

String ^ GemStone::GemFire::Cache::DataInput::ReadUTFHuge (  ) 

Read a string after java-modified UTF-8 decoding from the stream.

void GemStone::GemFire::Cache::DataInput::Reset (  ) 

Reset the cursor to the start of buffer.

void GemStone::GemFire::Cache::DataInput::RewindCursor ( int32_t  offset  ) 

Rewind the cursor of the buffer by the given offset.

Parameters:
offset The offset(number of bytes) by which to rewind the cursor.


Property Documentation

uint32_t GemStone::GemFire::Cache::DataInput::BytesRead [get]

Get the count of bytes that have been read from the stream.

uint32_t GemStone::GemFire::Cache::DataInput::BytesRemaining [get]

Get the count of bytes that are remaining in the buffer.

IntPtr GemStone::GemFire::Cache::DataInput::NativeIntPtr [get]

Get the underlying native unmanaged pointer.


GemFire C++ Cache .NET API Documentation