Pivotal GemFire Native .NET Reference  10.2.0
Apache::Geode::Client::CacheableHashTable Class Reference

A mutable ICacheableKey to ISerializable hash table that can serve as a distributable object for caching. More...

Inherits Apache::Geode::Client::CacheableHashMap.

Public Member Functions

 CacheableHashTable ()
 Allocates a new empty instance. More...
 
 CacheableHashTable (Object^ dictionary)
 Allocates a new instance copying from the given dictionary. More...
 
 CacheableHashTable (System::Int32 capacity)
 Allocates a new empty instance with given initial size. More...
 
virtual void FromData (DataInput^ input) override
 Deserialize this object, typical implementation should return the 'this' pointer. More...
 
virtual void ToData (DataOutput^ output)
 Serializes this object. More...
 
String ^ ToString ()
 Return a string representation of the object. More...
 

Static Public Member Functions

static CacheableHashMapCreate ()
 Static function to create a new empty instance. More...
 
static ISerializableCreateDeserializable ()
 Factory function to register this class. More...
 

Properties

int8_t DsCode [get]
 Returns the classId of the instance being serialized. More...
 
virtual System::UInt64 ObjectSize [get]
 return the size of this object in bytes More...
 

Detailed Description

A mutable ICacheableKey to ISerializable hash table that can serve as a distributable object for caching.

This class extends .NET generic Dictionary class.

Constructor & Destructor Documentation

◆ CacheableHashTable() [1/3]

Apache::Geode::Client::CacheableHashTable::CacheableHashTable ( )
inline

Allocates a new empty instance.

◆ CacheableHashTable() [2/3]

Apache::Geode::Client::CacheableHashTable::CacheableHashTable ( Object^  dictionary)
inline

Allocates a new instance copying from the given dictionary.

Parameters
dictionaryThe dictionary whose elements are copied to this HashTable.

◆ CacheableHashTable() [3/3]

Apache::Geode::Client::CacheableHashTable::CacheableHashTable ( System::Int32  capacity)
inline

Allocates a new empty instance with given initial size.

Parameters
capacityThe initial capacity of the HashTable.

Member Function Documentation

◆ Create()

static CacheableHashMap ^ Apache::Geode::Client::CacheableHashMap::Create ( )
inlinestaticinherited

Static function to create a new empty instance.

◆ CreateDeserializable()

static ISerializable ^ Apache::Geode::Client::CacheableHashTable::CreateDeserializable ( )
inlinestatic

Factory function to register this class.

◆ FromData()

virtual void Apache::Geode::Client::CacheableHashTable::FromData ( DataInput input)
inlineoverridevirtual

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

Parameters
inputthe DataInput stream to use for reading the object data
Returns
the deserialized object

Reimplemented from Apache::Geode::Client::CacheableHashMap.

◆ ToData()

virtual void Apache::Geode::Client::CacheableHashMap::ToData ( DataOutput output)
virtualinherited

Serializes this object.

Parameters
outputthe DataOutput object to use for serializing the object

◆ ToString()

String ^ Apache::Geode::Client::ISerializable::ToString ( )
inherited

Return a string representation of the object.

Implemented in Apache::Geode::Client::Serializable, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableFileName, Apache::Geode::Client::CacheableDate, Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< NativeArray, NativeArray, ManagedType, DsCode >, Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)>, and Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)>.

Property Documentation

◆ DsCode

int8_t Apache::Geode::Client::CacheableHashTable::DsCode
get

Returns the classId of the instance being serialized.

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

Returns
the classId

◆ ObjectSize

virtual System:: UInt64 Apache::Geode::Client::CacheableHashMap::ObjectSize
getinherited

return the size of this object in bytes


Apache Geode C++ Cache .NET API Documentation