GridGain C++ Client Library
Public Member Functions | List of all members
gridgain::portable::PortableRawReader Class Reference

Portable raw reader. More...

#include <portable_raw_reader.h>

Public Member Functions

 PortableRawReader (gridgain::impl::portable::PortableReaderImpl *impl)
 Constructor. More...
 
int8_t ReadInt8 ()
 Read 8-byte signed integer. More...
 
int32_t ReadInt8Array (int8_t *res, const int32_t len)
 Read array of 8-byte signed integers. More...
 
bool ReadBool ()
 Read bool. More...
 
int32_t ReadBoolArray (bool *res, const int32_t len)
 Read array of bools. More...
 
int16_t ReadInt16 ()
 Read 16-byte signed integer. More...
 
int32_t ReadInt16Array (int16_t *res, const int32_t len)
 Read array of 16-byte signed integers. More...
 
uint16_t ReadUInt16 ()
 Read 16-byte unsigned integer. More...
 
int32_t ReadUInt16Array (uint16_t *res, const int32_t len)
 Read array of 16-byte unsigned integers. More...
 
int32_t ReadInt32 ()
 Read 32-byte signed integer. More...
 
int32_t ReadInt32Array (int32_t *res, const int32_t len)
 Read array of 32-byte signed integers. More...
 
int64_t ReadInt64 ()
 Read 64-byte signed integer. More...
 
int32_t ReadInt64Array (int64_t *res, const int32_t len)
 Read array of 64-byte signed integers. More...
 
float ReadFloat ()
 Read float. More...
 
int32_t ReadFloatArray (float *res, const int32_t len)
 Read array of floats. More...
 
double ReadDouble ()
 Read double. More...
 
int32_t ReadDoubleArray (double *res, const int32_t len)
 Read array of doubles. More...
 
Guid ReadGuid ()
 Read Guid. More...
 
int32_t ReadGuidArray (Guid *res, const int32_t len)
 Read array of Guids. More...
 
int32_t ReadString (char *res, const int32_t len)
 Read string. More...
 
std::string ReadString ()
 Read string from the stream. More...
 
PortableStringArrayReader ReadStringArray ()
 Start string array read. More...
 
template<typename T >
PortableArrayReader< T > ReadArray ()
 Start array read. More...
 
template<typename T >
PortableCollectionReader< T > ReadCollection ()
 Start collection read. More...
 
template<typename T , typename OutputIterator >
int32_t ReadCollection (OutputIterator out)
 Read values and insert them to specified position. More...
 
template<typename K , typename V >
PortableMapReader< K, V > ReadMap ()
 Start map read. More...
 
CollectionType ReadCollectionType ()
 Read type of the collection. More...
 
int32_t ReadCollectionSize ()
 Read type of the collection. More...
 
template<typename T >
T ReadObject ()
 Read object. More...
 

Detailed Description

Portable raw reader.

Constructor & Destructor Documentation

gridgain::portable::PortableRawReader::PortableRawReader ( gridgain::impl::portable::PortableReaderImpl *  impl)

Constructor.

Parameters
implImplementation.

Member Function Documentation

template<typename T >
PortableArrayReader<T> gridgain::portable::PortableRawReader::ReadArray ( )
inline

Start array read.

Returns
Array reader.
bool gridgain::portable::PortableRawReader::ReadBool ( )

Read bool.

Maps to "boolean" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadBoolArray ( bool *  res,
const int32_t  len 
)

Read array of bools.

Maps to "boolean[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
template<typename T >
PortableCollectionReader<T> gridgain::portable::PortableRawReader::ReadCollection ( )
inline

Start collection read.

Returns
Collection reader.
template<typename T , typename OutputIterator >
int32_t gridgain::portable::PortableRawReader::ReadCollection ( OutputIterator  out)
inline

Read values and insert them to specified position.

Parameters
outOutput iterator to the initial position in the destination sequence.
Returns
Number of elements that have been read.
int32_t gridgain::portable::PortableRawReader::ReadCollectionSize ( )

Read type of the collection.

Returns
Collection size.
CollectionType gridgain::portable::PortableRawReader::ReadCollectionType ( )

Read type of the collection.

Returns
Collection type.
double gridgain::portable::PortableRawReader::ReadDouble ( )

Read double.

Maps to "double" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadDoubleArray ( double *  res,
const int32_t  len 
)

Read array of doubles.

Maps to "double[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
float gridgain::portable::PortableRawReader::ReadFloat ( )

Read float.

Maps to "float" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadFloatArray ( float *  res,
const int32_t  len 
)

Read array of floats.

Maps to "float[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
Guid gridgain::portable::PortableRawReader::ReadGuid ( )

Read Guid.

Maps to "UUID" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadGuidArray ( Guid *  res,
const int32_t  len 
)

Read array of Guids.

Maps to "UUID[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
int16_t gridgain::portable::PortableRawReader::ReadInt16 ( )

Read 16-byte signed integer.

Maps to "short" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadInt16Array ( int16_t *  res,
const int32_t  len 
)

Read array of 16-byte signed integers.

Maps to "short[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
int32_t gridgain::portable::PortableRawReader::ReadInt32 ( )

Read 32-byte signed integer.

Maps to "int" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadInt32Array ( int32_t *  res,
const int32_t  len 
)

Read array of 32-byte signed integers.

Maps to "int[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
int64_t gridgain::portable::PortableRawReader::ReadInt64 ( )

Read 64-byte signed integer.

Maps to "long" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadInt64Array ( int64_t *  res,
const int32_t  len 
)

Read array of 64-byte signed integers.

Maps to "long[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
int8_t gridgain::portable::PortableRawReader::ReadInt8 ( )

Read 8-byte signed integer.

Maps to "byte" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadInt8Array ( int8_t *  res,
const int32_t  len 
)

Read array of 8-byte signed integers.

Maps to "byte[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
template<typename K , typename V >
PortableMapReader<K, V> gridgain::portable::PortableRawReader::ReadMap ( )
inline

Start map read.

Returns
Map reader.
template<typename T >
T gridgain::portable::PortableRawReader::ReadObject ( )
inline

Read object.

Returns
Object.
int32_t gridgain::portable::PortableRawReader::ReadString ( char *  res,
const int32_t  len 
)

Read string.

Parameters
resArray to store data to.
lenExpected length of string. NULL terminator will be set in case len is greater than real string length.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.
std::string gridgain::portable::PortableRawReader::ReadString ( )
inline

Read string from the stream.

Returns
String.
PortableStringArrayReader gridgain::portable::PortableRawReader::ReadStringArray ( )

Start string array read.

Returns
String array reader.
uint16_t gridgain::portable::PortableRawReader::ReadUInt16 ( )

Read 16-byte unsigned integer.

Maps to "char" type in Java.

Returns
Result.
int32_t gridgain::portable::PortableRawReader::ReadUInt16Array ( uint16_t *  res,
const int32_t  len 
)

Read array of 16-byte unsigned integers.

Maps to "char[]" type in Java.

Parameters
resArray to store data to.
lenExpected length of array.
Returns
Actual amount of elements read. If "len" argument is less than actual array size or resulting array is set to null, nothing will be written to resulting array and returned value will contain required array length. -1 will be returned in case array in stream was null.

The documentation for this class was generated from the following files: