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

---

Detailed Description

Provides operations for reading primitive data values and user-defined objects from a byte stream.

Public Member Functions
	!DataInput ()
void	AdvanceCursor (size_t offset)
	DataInput (array< Byte >^buffer, size_t len)
	DataInput (array< Byte >^buffer)
Boolean	ReadBoolean ()
Byte	ReadByte ()
array< Byte >^	ReadBytes ()
array< Byte >^	ReadBytesOnly (UInt32 len)
Double	ReadDouble ()
Single	ReadFloat ()
Int16	ReadInt16 ()
Int32	ReadInt32 ()
Int64	ReadInt64 ()
IGFSerializable^	ReadObject ()
SByte	ReadSByte ()
array< SByte >^	ReadSBytes ()
array< SByte >^	ReadSBytesOnly (UInt32 len)
UInt16	ReadUInt16 ()
UInt32	ReadUInt32 ()
UInt64	ReadUInt64 ()
String^	ReadUtf ()
	~DataInput ()
Properties
UInt32	BytesRead [get]
IntPtr	NativeIntPtr [get]

---

Constructor & Destructor Documentation

GemStone::GemFire::Cache::DataInput::DataInput

(

array< Byte >^

buffer

)

Construct DataInput using the 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,
		size_t	len
	)

Construct DataInput using a portion of the given 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

(

size_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.

Boolean 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

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.

Single GemStone::GemFire::Cache::DataInput::ReadFloat

(

)

Read a floating point number from the stream.

Int16 GemStone::GemFire::Cache::DataInput::ReadInt16

(

)

Read a 16-bit integer from the stream.

Int32 GemStone::GemFire::Cache::DataInput::ReadInt32

(

)

Read a 32-bit integer from the stream.

Int64 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

len

)

Read the given number of signed bytes from the stream.

Parameters:

len

Number of signed bytes to read.

UInt16 GemStone::GemFire::Cache::DataInput::ReadUInt16

(

)

Read a 16-bit unsigned integer from the stream.

UInt32 GemStone::GemFire::Cache::DataInput::ReadUInt32

(

)

Read a 32-bit unsigned integer from the stream.

UInt64 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.

---

Property Documentation

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

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

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

Get the underlying native unmanaged pointer.

---