VMware GemFire Native Client C++ API Reference

constructors

Factory method that creates the key type that matches the type of value.

For user defined derivations of CacheableKey, the method apache::geode::client::CacheableKey::create may be overloaded.

Factory method that creates the Serializable object that matches the type of value.

For user defined derivations of Serializable, the method apache::geode::client::Serializable::create may be overloaded.

Creates and returns a WritablePdxInstance whose initial values are those of this PdxInstance.

This call returns a copy of the current field values so modifications made to the returned value will not modify this PdxInstance.

Returns

a WritablePdxInstance

Deserialize this object.

This is an internal method.

Parameters

input

to deserialize the PDX object

Implements apache::geode::client::PdxSerializable.

Reads the named field and sets its value in bool array type out param.

bool* type corresponds to the Java boolean[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in bool type out param.

bool type corresponds to the Java boolean type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in signed char array type out param.

int8_t* type corresponds to the Java byte[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in signed char type out param.

signed char type corresponds to the Java byte type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in std::shared_ptr<CacheableDate> type out param.

std::shared_ptr<CacheableDate> type is corresponding to java Java.util.date type.

Parameters

fieldname

name of the field to read std::shared_ptr<CacheableDate> type.

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in std::shared_ptr<Cacheable> type out param.

std::shared_ptr<Cacheable> type corresponds to the Java object type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field. For deserialization C++ Native Client requires the domain class to be registered.

See also

serializationRegistry->addPdxType

PdxInstance::hasField

Reads the named field and sets its value in std::shared_ptr<CacheableObjectArray> type out param.

For deserialization C++ Native Client requires the domain class to be registered. std::shared_ptr<CacheableObjectArray> type corresponds to the Java Object[] type.

Parameters

fieldname

name of the field to read. std::shared_ptr<CacheableObjectArray> type.

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

serializationRegistry->addPdxType

PdxInstance::hasField

Reads the named field and sets its value in char array type out param.

char16_t* type corresponds to the Java char[] type.

Parameters

fieldName

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in char type out param.

char type corresponds to the Java char type.

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Return the full name of the class that this pdx instance represents.

Returns

the name of the class that this pdx instance represents.

Exceptions

IllegalStateException

if the PdxInstance typeid is not defined yet, to get classname or if PdxType is not defined for PdxInstance.

Implements apache::geode::client::PdxSerializable.

Reads the named field and sets its value in double array type out param.

double* type corresponds to the Java double[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in double type out param.

double type corresponds to the Java double type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in array of byte arrays type out param.

int8_t** type corresponds to the Java byte[][] type.

Parameters

fieldName	name of the field to read.
value	value of the field to be set with array of byte arrays type.
arrayLength	arrayLength is set to the number of byte arrays.
elementLength	elementLength is set to individual byte array lengths.

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Return an unmodifiable list of the field names on this PdxInstance.

Returns

an unmodifiable list of the field names on this PdxInstance

Return the type.

See also

PdxInstance::PdxFieldTypes of the field in the pdx instance.

Returns

the type

See also

PdxInstance::PdxFieldTypes of the field in the pdx instance.

Exceptions

IllegalStateException

if the PdxInstance typeid is not defined yet, to get classname or if PdxType is not defined for PdxInstance.

Reads the named field and sets its value in float array type out param.

float* type corresponds to the Java float[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in float type out param.

float type corresponds to the Java float type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in int32_t array type out param.

int32_t* type corresponds to the Java int[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in int32_t type out param.

int32_t type corresponds to the Java int type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

Reads the named field and sets its value in int64_t array type out param.

int64_t* type corresponds to the Java long[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in int64_t type out param.

int64_t type corresponds to the Java long type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Deserializes and returns the domain object that this instance represents.

For deserialization C++ Native Client requires the domain class to be registered.

Returns

the deserialized domain object.

See also

serializationRegistry->addPdxType

Reads the named field and sets its value in int16_t array type out param.

int16_t* type corresponds to the Java short[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in int16_t type out param.

int16_t type corresponds to the Java short type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field as a string array.

std::vector<std::string> type corresponds to the Java String[] type.

Parameters

fieldname

name of the field to read

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Reads the named field and sets its value in std::string type out param.

std::string type corresponds to the Java String type.

Parameters

fieldname

name of the field to read

Returns

string value for field.

Exceptions

IllegalStateException

if PdxInstance doesn't have the named field.

See also

PdxInstance::hasField

Checks if the named field exists and returns the result.

This can be useful when writing code that handles more than one version of a PDX class.

Parameters

fieldname

the name of the field to check

Returns

true if the named field exists; otherwise false

Generates a hashcode based on the identity fields of this PdxInstance.

If a PdxInstance has marked identity fields using PdxWriter#markIdentityField then only the marked identity fields are its identity fields. Otherwise all its fields are identity fields.

For deserialization C++ Native Client requires the domain class to be registered. If the field is an array then all array elements are used for hashcode computation. Otherwise the raw bytes of its value are used to compute the hash code.

Exceptions

IllegalStateException

if the field contains an element that is not of CacheableKey derived type.

See also

serializationRegistry->addPdxType

Implements apache::geode::client::CacheableKey.

Checks if the named field was PdxWriter#markIdentityFieldmarked as an identity field.

Note that if no fields have been marked then all the fields are used as identity fields even though this method will return false since none of them have been marked.

Parameters

fieldname

the name of the field to check

Returns

true if the named field exists and was marked as an identify field; otherwise false

Returns

the size of the object in bytes This is an internal method. It is used in case of heap LRU property is set.

Reimplemented from apache::geode::client::Serializable.

Returns true if the given CacheableKey derived object is equals to this instance.

If other is not a PdxInstance then it is not equal to this instance. NOTE: Even if other is the result of calling getObject() it will not be equal to this instance

.

Otherwise equality of two PdxInstances is determined as follows:

1. The domain class name must be equal for both PdxInstances
2. Each identity field must be equal.

If one of the instances does not have a field that the other one does then equals will assume it has the field with a default value. If a PdxInstance has marked identity fields using markIdentityField then only the marked identity fields are its identity fields. Otherwise all its fields are identity fields.

An identity field is equal if all the following are true:

1. The field name is equal.
2. The field type is equal.
3. The field value is equal.

If an identity field is of type derived from Cacheable then it is deserialized. For deserialization C++ Native Client requires the domain class to be registered. If the deserialized object is an array then all array elements are used to determine equality. If an identity field is of type CacheableObjectArray then it is deserialized and all array elements are used to determine equality. For all other field types the value does not need to be deserialized. Instead the serialized raw bytes are compared and used to determine equality.

Parameters

other

the other instance to compare to this.

Returns

true if this instance is equal to other.

Exceptions

IllegalStateException

if the field contains an element that is not of CacheableKey derived type.

See also

serializationRegistry->addPdxType

Implements apache::geode::client::CacheableKey.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. bool type is corresponding to java boolean type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type bool

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. char type is corresponding to java char type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type char

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. char* type is corresponding to java String type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type char*

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. bool* type is corresponding to java boolean[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type bool array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. char16_t* type is corresponding to java char[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type char16_t array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. double* type is corresponding to java double[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type double array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. float* type is corresponding to java float[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type float array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int16_t* type is corresponding to java short[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type int16_t array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int32_t* type is corresponding to java int[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type int32_t array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int64_t* type is corresponding to java long[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type int64_t array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int8_t* type is corresponding to java byte[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type int8_t array

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. double type is corresponding to java double type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type double

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. float type is corresponding to java float type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type float

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int16_t type is corresponding to java short type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type int16_t

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int32_t type is corresponding to java int type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type int32_t

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int64_t type is corresponding to java long type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type int64_t

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. int8_t** type is corresponding to java byte[][] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type array of byte arrays
arrayLength	The number of byte arrays.
elementLength	The lengths of individual byte arrays.

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. signed char type is corresponding to java byte type. For C++ on Windows and Linux, signed char type is corresponding to int8_t type. However C++ users on Solaris should always use this api after casting int8_t to signed char.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type signed char

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. std::shared_ptr<Cacheable> type is corresponding to java object type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type std::shared_ptr<Cacheable>

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. std::shared_ptr<CacheableDate> type is corresponding to java Java.util.date type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type std::shared_ptr<CacheableDate>

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. std::shared_ptr<CacheableObjectArray> type is corresponding to java Object[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type std::shared_ptr<CacheableObjectArray>

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. char** type is corresponding to java String[] type.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type char* array
length	The number of elements in CString array type.

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

Set the existing named field to the given value.

The setField method has copy-on-write semantics. So for the modifications to be stored in the cache the WritablePdxInstance must be put into a region after setField has been called one or more times. unsigned char type is corresponding to java byte type. For C++ on Windows and Linux, unsigned char type is corresponding to int8_t type. However C++ users on Solaris should always use this api after casting int8_t to unsigned char.

Parameters

fieldName	name of the field whose value will be set
value	value that will be set to the field of type unsigned char

Exceptions

IllegalStateException

if the named field does not exist or if the type of the value is not compatible with the field.

serialize this object in geode PDX format.

This is an internal method.

Parameters

output

to serialize the PDX object

Implements apache::geode::client::PdxSerializable.

Prints out all of the identity fields of this PdxInstance.

If a PdxInstance has marked identity fields using PdxWriter#markIdentityField then only the marked identity fields are its identity fields. Otherwise all its fields are identity fields

. For deserialization C++ Native Client requires the domain class to be registered.

See also

serializationRegistry->addPdxType

Reimplemented from apache::geode::client::Serializable.