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

Portable reader. More...

#include <portable_reader.h>

Public Member Functions

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

Detailed Description

Portable reader.

Constructor & Destructor Documentation

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

Constructor.

Parameters
implImplementation.

Member Function Documentation

PortableRawReader gridgain::portable::PortableReader::RawReader ( )

Get raw reader for this reader.

Returns
Raw reader.
template<typename T >
PortableArrayReader<T> gridgain::portable::PortableReader::ReadArray ( const char *  fieldName)
inline

Start array read.

Parameters
fieldNameField name.
Returns
Array reader.
bool gridgain::portable::PortableReader::ReadBool ( const char *  fieldName)

Read bool.

Maps to "short" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadBoolArray ( const char *  fieldName,
bool *  res,
int32_t  len 
)

Read array of bools.

Maps to "bool[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadCollection ( const char *  fieldName)
inline

Start collection read.

Parameters
fieldNameField name.
Returns
Collection reader.
template<typename T , typename OutputIterator >
int32_t gridgain::portable::PortableReader::ReadCollection ( const char *  fieldName,
OutputIterator  out 
)
inline

Read values and insert them to specified position.

Parameters
fieldNameField name.
outOutput iterator to the initial position in the destination sequence.
Returns
Number of elements that have been read.
int32_t gridgain::portable::PortableReader::ReadCollectionSize ( const char *  fieldName)

Read type of the collection.

Parameters
fieldNameField name.
Returns
Collection size.
CollectionType gridgain::portable::PortableReader::ReadCollectionType ( const char *  fieldName)

Read type of the collection.

Parameters
fieldNameField name.
Returns
Collection type.
double gridgain::portable::PortableReader::ReadDouble ( const char *  fieldName)

Read double.

Maps to "double" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadDoubleArray ( const char *  fieldName,
double *  res,
int32_t  len 
)

Read array of doubles.

Maps to "double[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadFloat ( const char *  fieldName)

Read float.

Maps to "float" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadFloatArray ( const char *  fieldName,
float *  res,
int32_t  len 
)

Read array of floats.

Maps to "float[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadGuid ( const char *  fieldName)

Read Guid.

Maps to "UUID" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadGuidArray ( const char *  fieldName,
Guid *  res,
int32_t  len 
)

Read array of Guids.

Maps to "UUID[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadInt16 ( const char *  fieldName)

Read 16-byte signed integer.

Maps to "short" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadInt16Array ( const char *  fieldName,
int16_t *  res,
int32_t  len 
)

Read array of 16-byte signed integers.

Maps to "short[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadInt32 ( const char *  fieldName)

Read 32-byte signed integer.

Maps to "int" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadInt32Array ( const char *  fieldName,
int32_t *  res,
int32_t  len 
)

Read array of 32-byte signed integers.

Maps to "int[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadInt64 ( const char *  fieldName)

Read 64-byte signed integer.

Maps to "long" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadInt64Array ( const char *  fieldName,
int64_t *  res,
int32_t  len 
)

Read array of 64-byte signed integers.

Maps to "long[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadInt8 ( const char *  fieldName)

Read 8-byte signed integer.

Maps to "byte" type in Java.

Parameters
fieldNameField name.
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadInt8Array ( const char *  fieldName,
int8_t *  res,
const int32_t  len 
)

Read array of 8-byte signed integers.

Maps to "byte[]" type in Java.

Parameters
fieldNameField name.
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::PortableReader::ReadMap ( const char *  fieldName)
inline

Start map read.

Parameters
fieldNameField name.
Returns
Map reader.
template<typename T >
T gridgain::portable::PortableReader::ReadObject ( const char *  fieldName)
inline

Read object.

Parameters
fieldNameField name.
Returns
Object.
int32_t gridgain::portable::PortableReader::ReadString ( const char *  fieldName,
char *  res,
int32_t  len 
)

Read string.

Parameters
fieldNameField name.
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::PortableReader::ReadString ( const char *  fieldName)
inline

Read string from the stream.

Parameters
fieldNameField name.
Returns
String.
PortableStringArrayReader gridgain::portable::PortableReader::ReadStringArray ( const char *  fieldName)

Start string array read.

Parameters
fieldNameField name.
Returns
String array reader.
uint16_t gridgain::portable::PortableReader::ReadUInt16 ( const char *  fieldName)

Read 16-byte unsigned integer.

Maps to "char" type in Java.

Parameters
fieldNameField name.
Returns
Result.
int32_t gridgain::portable::PortableReader::ReadUInt16Array ( const char *  fieldName,
uint16_t *  res,
int32_t  len 
)

Read array of 16-byte unsigned integers.

Maps to "char[]" type in Java.

Parameters
fieldNameField name.
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: