Apache::Geode::Client::IGeodeSerializable Interface Reference

This interface class is the superclass of all user objects in the cache that can be serialized. More...

Inherited by Apache::Geode::Client::CacheableHashMap, Apache::Geode::Client::CacheableLinkedList, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableObjectArray, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableStack, Apache::Geode::Client::CacheableUndefined, Apache::Geode::Client::CacheableVector, Apache::Geode::Client::ICacheableKey, Apache::Geode::Client::Properties< TPropKey, TPropValue >, Apache::Geode::Client::RegionAttributes< TKey, TValue >, Apache::Geode::Client::Serializable, Apache::Geode::Client::UserFunctionExecutionException, and Apache::Geode::Client::Properties< String^, String^>.

Public Member Functions
IGeodeSerializable ^	FromData (DataInput^ input)
	Deserialize this object, typical implementation should return the 'this' pointer. More...
void	ToData (DataOutput^ output)
	Serializes this object. More...
String ^	ToString ()
	Return a string representation of the object. More...

Properties
System::UInt32	ClassId [get]
	Returns the classId of the instance being serialized. More...
System::UInt32	ObjectSize [get]
	Get the size of this object in bytes. More...

Detailed Description

This interface class is the superclass of all user objects in the cache that can be serialized.

Member Function Documentation

FromData()

IGeodeSerializable ^ Apache::Geode::Client::IGeodeSerializable::FromData

(

DataInput^

input

)

Deserialize this object, typical implementation should return the 'this' pointer.

Parameters

input

the DataInput stream to use for reading the object data

Returns

the deserialized object

Implemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt32Array, apache::geode::client::CacheableInt32ArrayPtr, System::Int32, GeodeClassIds::CacheableInt32Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableDoubleArray, apache::geode::client::CacheableDoubleArrayPtr, Double, GeodeClassIds::CacheableDoubleArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt16Array, apache::geode::client::CacheableInt16ArrayPtr, System::Int16, GeodeClassIds::CacheableInt16Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableBytes, apache::geode::client::CacheableBytesPtr, Byte, GeodeClassIds::CacheableBytes >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CharArray, apache::geode::client::CharArrayPtr, Char, GeodeClassIds::CharArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableFloatArray, apache::geode::client::CacheableFloatArrayPtr, Single, GeodeClassIds::CacheableFloatArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::BooleanArray, apache::geode::client::BooleanArrayPtr, bool, GeodeClassIds::BooleanArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt64Array, apache::geode::client::CacheableInt64ArrayPtr, System::Int64, GeodeClassIds::CacheableInt64Array >, Apache::Geode::Client::CacheableHashTable, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >, Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableLinkedHashSet, apache::geode::client::CacheableLinkedHashSet >, Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableHashSet, apache::geode::client::CacheableHashSet >, Apache::Geode::Client::RegionAttributes< TKey, TValue >, Apache::Geode::Client::Properties< TPropKey, TPropValue >, Apache::Geode::Client::Properties< String^, String^>, Apache::Geode::Client::CacheableObjectArray, Apache::Geode::Client::CacheableHashMap, Apache::Geode::Client::CacheableLinkedList, Apache::Geode::Client::CacheableDate, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableVector, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableStack, Apache::Geode::Client::CacheableFileName, Apache::Geode::Client::CacheableUndefined, Apache::Geode::Client::UserFunctionExecutionException, and Apache::Geode::Client::Serializable.

ToData()

void Apache::Geode::Client::IGeodeSerializable::ToData

(

DataOutput^

output

)

Serializes this object.

Parameters

output

the DataOutput object to use for serializing the object

Implemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt32Array, apache::geode::client::CacheableInt32ArrayPtr, System::Int32, GeodeClassIds::CacheableInt32Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableDoubleArray, apache::geode::client::CacheableDoubleArrayPtr, Double, GeodeClassIds::CacheableDoubleArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt16Array, apache::geode::client::CacheableInt16ArrayPtr, System::Int16, GeodeClassIds::CacheableInt16Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableBytes, apache::geode::client::CacheableBytesPtr, Byte, GeodeClassIds::CacheableBytes >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CharArray, apache::geode::client::CharArrayPtr, Char, GeodeClassIds::CharArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableFloatArray, apache::geode::client::CacheableFloatArrayPtr, Single, GeodeClassIds::CacheableFloatArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::BooleanArray, apache::geode::client::BooleanArrayPtr, bool, GeodeClassIds::BooleanArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt64Array, apache::geode::client::CacheableInt64ArrayPtr, System::Int64, GeodeClassIds::CacheableInt64Array >, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >, Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableLinkedHashSet, apache::geode::client::CacheableLinkedHashSet >, Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableHashSet, apache::geode::client::CacheableHashSet >, Apache::Geode::Client::RegionAttributes< TKey, TValue >, Apache::Geode::Client::Properties< TPropKey, TPropValue >, Apache::Geode::Client::Properties< String^, String^>, Apache::Geode::Client::CacheableObjectArray, Apache::Geode::Client::CacheableHashMap, Apache::Geode::Client::CacheableLinkedList, Apache::Geode::Client::CacheableDate, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableVector, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableStack, Apache::Geode::Client::CacheableFileName, Apache::Geode::Client::CacheableUndefined, Apache::Geode::Client::UserFunctionExecutionException, and Apache::Geode::Client::Serializable.

ToString()

String ^ Apache::Geode::Client::IGeodeSerializable::ToString

(

)

Return a string representation of the object.

Implemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt32Array, apache::geode::client::CacheableInt32ArrayPtr, System::Int32, GeodeClassIds::CacheableInt32Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableDoubleArray, apache::geode::client::CacheableDoubleArrayPtr, Double, GeodeClassIds::CacheableDoubleArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt16Array, apache::geode::client::CacheableInt16ArrayPtr, System::Int16, GeodeClassIds::CacheableInt16Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableBytes, apache::geode::client::CacheableBytesPtr, Byte, GeodeClassIds::CacheableBytes >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CharArray, apache::geode::client::CharArrayPtr, Char, GeodeClassIds::CharArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableFloatArray, apache::geode::client::CacheableFloatArrayPtr, Single, GeodeClassIds::CacheableFloatArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::BooleanArray, apache::geode::client::BooleanArrayPtr, bool, GeodeClassIds::BooleanArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt64Array, apache::geode::client::CacheableInt64ArrayPtr, System::Int64, GeodeClassIds::CacheableInt64Array >, Apache::Geode::Client::Properties< TPropKey, TPropValue >, Apache::Geode::Client::Properties< String^, String^>, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Serializable, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableDate, Apache::Geode::Client::CacheableFileName, Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableFloat, Single, GeodeClassIds::CacheableFloat >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt32, System::Int32, GeodeClassIds::CacheableInt32 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableDouble, Double, GeodeClassIds::CacheableDouble >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableBoolean, bool, GeodeClassIds::CacheableBoolean >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt64, System::Int64, GeodeClassIds::CacheableInt64 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt16, System::Int16, GeodeClassIds::CacheableInt16 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableWideChar, Char, GeodeClassIds::CacheableCharacter >, and Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableByte, Byte, GeodeClassIds::CacheableByte >.

Property Documentation

ClassId

System:: UInt32 Apache::Geode::Client::IGeodeSerializable::ClassId

get

Returns the classId of the instance being serialized.

This is used by deserialization to determine what instance type to create and deserialize into.

The classId must be unique within an application suite and in the range 0 to ((2^31)-1) both inclusive. An application can thus define upto 2^31 custom IGeodeSerializable classes. Returning a value greater than ((2^31)-1) may result in undefined behaviour.

Returns

the classId

ObjectSize

System:: UInt32 Apache::Geode::Client::IGeodeSerializable::ObjectSize

get

Get the size of this object in bytes.

This is only needed if you use the HeapLRU feature.

Note that you can simply return zero if you are not using the HeapLRU feature.

Returns

the size of this object in bytes.