GemStone::GemFire::Cache::ICacheableKey

GemStone::GemFire::Cache::ICacheableKey Interface Reference

Inherits GemStone::GemFire::Cache::IGFSerializable.

Inherited by GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, and GemStone::GemFire::Cache::CacheableKey.

Detailed Description

This interface class is the superclass of all user objects in the cache that can be used as a key.

If an implementation is desired to be act as a key in the cache, then it must implement this interface and preferably override System.Object.ToString to obtain proper string representation.

Public Member Functions

Boolean Equals (ICacheableKey^ other)
IGFSerializable^ FromData (DataInput^ input)
Int32 GetHashCode ()
void ToData (DataOutput^ output)
String^ ToString ()

Properties

Byte ClassId [get]
UInt32 ObjectSize [get]

Member Function Documentation

Boolean GemStone::GemFire::Cache::ICacheableKey::Equals ( ICacheableKey^   other  ) 

Returns true if this ICacheableKey matches the other.

Implemented in GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableKey, GemStone::GemFire::Cache::CacheableString, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireTypeIds::CacheableCharacter >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireTypeIds::CacheableFloat >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableBoolean, Boolean, GemFireTypeIds::CacheableBoolean >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireTypeIds::CacheableByte >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt16, Int16, GemFireTypeIds::CacheableInt16 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt32, Int32, GemFireTypeIds::CacheableInt32 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireTypeIds::CacheableDouble >, and GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt64, Int64, GemFireTypeIds::CacheableInt64 >.

IGFSerializable ^ GemStone::GemFire::Cache::IGFSerializable::FromData ( DataInput^   input  )  [inherited]

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 GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableHashMap, GemStone::GemFire::Cache::CacheableObject, GemStone::GemFire::Cache::CacheableObjectXml, GemStone::GemFire::Cache::CacheableUndefined, GemStone::GemFire::Cache::CacheableVector, GemStone::GemFire::Cache::Properties, GemStone::GemFire::Cache::RegionAttributes, and GemStone::GemFire::Cache::Serializable.

Int32 GemStone::GemFire::Cache::ICacheableKey::GetHashCode (  ) 

Get the hash code for this object. This is used in the internal hash tables and so must have a nice distribution pattern.

Returns:
The hashcode for this object.

Implemented in GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableKey, and GemStone::GemFire::Cache::CacheableString.

void GemStone::GemFire::Cache::IGFSerializable::ToData ( DataOutput^   output  )  [inherited]

Serializes this object.

Parameters:
output the DataOutput object to use for serializing the object

Implemented in GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableHashMap, GemStone::GemFire::Cache::CacheableObject, GemStone::GemFire::Cache::CacheableObjectXml, GemStone::GemFire::Cache::CacheableUndefined, GemStone::GemFire::Cache::CacheableVector, GemStone::GemFire::Cache::Properties, GemStone::GemFire::Cache::RegionAttributes, and GemStone::GemFire::Cache::Serializable.

String ^ GemStone::GemFire::Cache::IGFSerializable::ToString (  )  [inherited]

Return a string representation of the object.

Implemented in GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableObject, GemStone::GemFire::Cache::CacheableObjectXml, GemStone::GemFire::Cache::CacheableString, GemStone::GemFire::Cache::Serializable, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireTypeIds::CacheableCharacter >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireTypeIds::CacheableFloat >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableBoolean, Boolean, GemFireTypeIds::CacheableBoolean >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireTypeIds::CacheableByte >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt16, Int16, GemFireTypeIds::CacheableInt16 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt32, Int32, GemFireTypeIds::CacheableInt32 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireTypeIds::CacheableDouble >, and GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt64, Int64, GemFireTypeIds::CacheableInt64 >.

Property Documentation

Byte GemStone::GemFire::Cache::IGFSerializable::ClassId [get, inherited]

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-127 both inclusive. An application can thus define upto 128 custom IGFSerializable classes. Returning a value greater than 127 will result in undefined behaviour.

Returns:
the classId

Implemented in GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::Internal::CacheableBuiltinArray< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableHashMap, GemStone::GemFire::Cache::CacheableHashSet, GemStone::GemFire::Cache::CacheableObject, GemStone::GemFire::Cache::CacheableObjectXml, GemStone::GemFire::Cache::CacheableStringArray, GemStone::GemFire::Cache::CacheableUndefined, GemStone::GemFire::Cache::CacheableVector, GemStone::GemFire::Cache::Properties, GemStone::GemFire::Cache::RegionAttributes, GemStone::GemFire::Cache::Serializable, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireTypeIds::CacheableCharacter >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireTypeIds::CacheableFloat >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableBoolean, Boolean, GemFireTypeIds::CacheableBoolean >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireTypeIds::CacheableByte >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt16, Int16, GemFireTypeIds::CacheableInt16 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt32, Int32, GemFireTypeIds::CacheableInt32 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireTypeIds::CacheableDouble >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt64, Int64, GemFireTypeIds::CacheableInt64 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinArray< gemfire::CacheableInt16Array, Int16, GemFireTypeIds::CacheableInt16Array >, GemStone::GemFire::Cache::Internal::CacheableBuiltinArray< gemfire::CacheableInt32Array, Int32, GemFireTypeIds::CacheableInt32Array >, GemStone::GemFire::Cache::Internal::CacheableBuiltinArray< gemfire::CacheableInt64Array, Int64, GemFireTypeIds::CacheableInt64Array >, GemStone::GemFire::Cache::Internal::CacheableBuiltinArray< gemfire::CacheableBytes, Byte, GemFireTypeIds::CacheableBytes >, GemStone::GemFire::Cache::Internal::CacheableBuiltinArray< gemfire::CacheableDoubleArray, Double, GemFireTypeIds::CacheableDoubleArray >, and GemStone::GemFire::Cache::Internal::CacheableBuiltinArray< gemfire::CacheableFloatArray, Single, GemFireTypeIds::CacheableFloatArray >.

UInt32 GemStone::GemFire::Cache::IGFSerializable::ObjectSize [get, inherited]

Get the size of this object in bytes.

Returns:
the size of this object in bytes.

Implemented in GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableHashMap, GemStone::GemFire::Cache::CacheableObject, GemStone::GemFire::Cache::CacheableObjectXml, GemStone::GemFire::Cache::CacheableUndefined, GemStone::GemFire::Cache::CacheableVector, GemStone::GemFire::Cache::Properties, GemStone::GemFire::Cache::RegionAttributes, and GemStone::GemFire::Cache::Serializable.

GemFire C++ Cache .NET API Documentation