Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID > Class Template Reference

An immutable template wrapper for C++ CacheableKeys that can serve as a distributable key object for caching. More...

Inherits Apache::Geode::Client::CacheableKey.

Public Member Functions
	CacheableBuiltinKey ()
	Allocates a new instance More...
	CacheableBuiltinKey (TManaged value)
	Allocates a new instance with the given value. More...
virtual bool	Equals (ICacheableKey^ other) override
	Return true if this key matches other object. More...
virtual bool	Equals (Object^ obj) override
	Return true if this key matches other object. More...
virtual Apache::Geode::Client::IGeodeSerializable ^	FromData (Apache::Geode::Client::DataInput^ input)
	Deserializes the native (C++) object – returns an instance of the Serializable class with the native object wrapped inside. More...
virtual System::Int32	GetHashCode () override
	Return the hashcode for this key. More...
bool	operator== (TManaged other)
	Comparison operator against another value. More...
virtual void	ToData (Apache::Geode::Client::DataOutput^ output)
	Serializes this native (C++) object. More...
virtual String ^	ToString () override
	Return a string representation of the object. More...

Static Public Member Functions
static	operator Apache::Geode::Client::Serializable^ (array< bool >^ value)
	Implicit conversion operator from an boolean array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Byte >^ value)
	Implicit conversion operator from an array of bytes to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Char >^ value)
	Implicit conversion operator from a character array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Double >^ value)
	Implicit conversion operator from a double array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Single >^ value)
	Implicit conversion operator from a float array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< String^>^ value)
	Implicit conversion operator from a string array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< System::Int16 >^ value)
	Implicit conversion operator from a 16-bit integer array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< System::Int32 >^ value)
	Implicit conversion operator from a 32-bit integer array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< System::Int64 >^ value)
	Implicit conversion operator from a 64-bit integer array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (bool value)
	Implicit conversion operator from a boolean to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Byte value)
	Implicit conversion operator from a byte to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Char value)
	Implicit conversion operator from a character to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Double value)
	Implicit conversion operator from a double to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Single value)
	Implicit conversion operator from a float to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (String^ value)
	Implicit conversion operator from a string to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (System::Int16 value)
	Implicit conversion operator from a 16-bit integer to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (System::Int32 value)
	Implicit conversion operator from a 32-bit integer to a Serializable. More...
static	operator CacheableKey^ (bool value)
	Implicit conversion operator from a boolean to a CacheableKey. More...
static	operator CacheableKey^ (Byte value)
	Implicit conversion operator from a byte to a CacheableKey. More...
static	operator CacheableKey^ (Char value)
	Implicit conversion operator from a character to a CacheableKey. More...
static	operator CacheableKey^ (Double value)
	Implicit conversion operator from a double to a CacheableKey. More...
static	operator CacheableKey^ (Single value)
	Implicit conversion operator from a float to a CacheableKey. More...
static	operator CacheableKey^ (String^ value)
	Implicit conversion operator from a string to a CacheableKey. More...
static	operator CacheableKey^ (System::Int16 value)
	Implicit conversion operator from a 16-bit integer to a CacheableKey. More...
static	operator CacheableKey^ (System::Int32 value)
	Implicit conversion operator from a 32-bit integer to a CacheableKey. More...
static	operator CacheableKey^ (System::Int64 value)
	Implicit conversion operator from a 64-bit integer to a CacheableKey. More...
static	operator Serializable^ (System::Int64 value)
	Implicit conversion operator from a 64-bit integer to a Serializable. More...
static void	RegisterPdxSerializer (IPdxSerializer^ pdxSerializer)
	Set the PDX serializer for the cache. More...
static void	RegisterPdxType (PdxTypeFactoryMethod^ creationMethod)
static void	RegisterTypeGeneric (TypeFactoryMethodGeneric^ creationMethod)
	Register an instance factory method for a given type. More...
static void	SetPdxTypeMapper (IPdxTypeMapper^ pdxTypeMapper)
	Register an PdxTypeMapper to map the local types to pdx types More...

Protected Member Functions
	CacheableBuiltinKey (apache::geode::client::Serializable *nativeptr)
	Protected constructor to wrap a native object pointer More...

Properties
virtual System::UInt32	ClassId [get]
	Returns the classId of the instance being serialized. More...
virtual System::UInt32	ObjectSize [get]
	return the size of this object in bytes More...
TManaged	Value [get]
	Gets the value. More...

Detailed Description

template<typename TNative, typename TManaged, System::UInt32 TYPEID>
class Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >

An immutable template wrapper for C++ CacheableKeys that can serve as a distributable key object for caching.

Constructor & Destructor Documentation

CacheableBuiltinKey() [1/3]

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::CacheableBuiltinKey ( )

inline

Allocates a new instance

CacheableBuiltinKey() [2/3]

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::CacheableBuiltinKey ( TManaged  value )

inline

Allocates a new instance with the given value.

Parameters

value

the value of the new instance

CacheableBuiltinKey() [3/3]

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::CacheableBuiltinKey ( apache::geode::client::Serializable *  nativeptr )

inlineprotected

Protected constructor to wrap a native object pointer

Parameters

nativeptr

The native object pointer

Member Function Documentation

Equals() [1/2]

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

virtual bool Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::Equals ( ICacheableKey^  other )

inlineoverridevirtual

Return true if this key matches other object.

It invokes the '==' operator of the underlying native object.

Reimplemented from Apache::Geode::Client::CacheableKey.

Equals() [2/2]

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

virtual bool Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::Equals ( Object^  obj )

inlineoverridevirtual

Return true if this key matches other object.

It invokes the '==' operator of the underlying native object.

Reimplemented from Apache::Geode::Client::CacheableKey.

FromData()

virtual Apache::Geode::Client::IGeodeSerializable ^ Apache::Geode::Client::Serializable::FromData ( Apache::Geode::Client::DataInput^  input )

virtualinherited

Deserializes the native (C++) object – returns an instance of the Serializable class with the native object wrapped inside.

Parameters

input

the DataInput stream to use for reading the object data

Returns

the deserialized object

Implements Apache::Geode::Client::IGeodeSerializable.

Reimplemented 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 >, and Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableHashSet, apache::geode::client::CacheableHashSet >.

GetHashCode()

virtual System::Int32 Apache::Geode::Client::CacheableKey::GetHashCode ( )

overridevirtualinherited

Return the hashcode for this key.

It gets the hash code by calling the hashcode() function of the underlying apache::geode::client::CacheableKey object.

Implements Apache::Geode::Client::ICacheableKey.

Reimplemented in Apache::Geode::Client::CacheableString.

operator Apache::Geode::Client::Serializable^() [1/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< bool >^  value )

staticinherited

Implicit conversion operator from an boolean array to a Serializable.

operator Apache::Geode::Client::Serializable^() [2/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Byte >^  value )

staticinherited

Implicit conversion operator from an array of bytes to a Serializable.

operator Apache::Geode::Client::Serializable^() [3/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Char >^  value )

staticinherited

Implicit conversion operator from a character array to a Serializable.

operator Apache::Geode::Client::Serializable^() [4/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Double >^  value )

staticinherited

Implicit conversion operator from a double array to a Serializable.

operator Apache::Geode::Client::Serializable^() [5/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Single >^  value )

staticinherited

Implicit conversion operator from a float array to a Serializable.

operator Apache::Geode::Client::Serializable^() [6/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< String^>^  value )

staticinherited

Implicit conversion operator from a string array to a Serializable.

operator Apache::Geode::Client::Serializable^() [7/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int16 >^  value )

staticinherited

Implicit conversion operator from a 16-bit integer array to a Serializable.

operator Apache::Geode::Client::Serializable^() [8/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int32 >^  value )

staticinherited

Implicit conversion operator from a 32-bit integer array to a Serializable.

operator Apache::Geode::Client::Serializable^() [9/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int64 >^  value )

staticinherited

Implicit conversion operator from a 64-bit integer array to a Serializable.

operator Apache::Geode::Client::Serializable^() [10/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( bool  value )

staticinherited

Implicit conversion operator from a boolean to a Serializable.

operator Apache::Geode::Client::Serializable^() [11/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Byte  value )

staticinherited

Implicit conversion operator from a byte to a Serializable.

operator Apache::Geode::Client::Serializable^() [12/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Char  value )

staticinherited

Implicit conversion operator from a character to a Serializable.

operator Apache::Geode::Client::Serializable^() [13/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Double  value )

staticinherited

Implicit conversion operator from a double to a Serializable.

operator Apache::Geode::Client::Serializable^() [14/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Single  value )

staticinherited

Implicit conversion operator from a float to a Serializable.

operator Apache::Geode::Client::Serializable^() [15/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( String^  value )

staticinherited

Implicit conversion operator from a string to a Serializable.

operator Apache::Geode::Client::Serializable^() [16/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int16  value )

staticinherited

Implicit conversion operator from a 16-bit integer to a Serializable.

operator Apache::Geode::Client::Serializable^() [17/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int32  value )

staticinherited

Implicit conversion operator from a 32-bit integer to a Serializable.

operator CacheableKey^() [1/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( bool  value )

staticinherited

Implicit conversion operator from a boolean to a CacheableKey.

operator CacheableKey^() [2/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( Byte  value )

staticinherited

Implicit conversion operator from a byte to a CacheableKey.

operator CacheableKey^() [3/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( Char  value )

staticinherited

Implicit conversion operator from a character to a CacheableKey.

operator CacheableKey^() [4/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( Double  value )

staticinherited

Implicit conversion operator from a double to a CacheableKey.

operator CacheableKey^() [5/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( Single  value )

staticinherited

Implicit conversion operator from a float to a CacheableKey.

operator CacheableKey^() [6/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( String^  value )

staticinherited

Implicit conversion operator from a string to a CacheableKey.

operator CacheableKey^() [7/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( System::Int16  value )

staticinherited

Implicit conversion operator from a 16-bit integer to a CacheableKey.

operator CacheableKey^() [8/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( System::Int32  value )

staticinherited

Implicit conversion operator from a 32-bit integer to a CacheableKey.

operator CacheableKey^() [9/9]

static Apache::Geode::Client::CacheableKey::operator CacheableKey^ ( System::Int64  value )

staticinherited

Implicit conversion operator from a 64-bit integer to a CacheableKey.

operator Serializable^()

static Apache::Geode::Client::Serializable::operator Serializable^ ( System::Int64  value )

staticinherited

Implicit conversion operator from a 64-bit integer to a Serializable.

operator==()

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

bool Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::operator== ( TManaged  other )

inline

Comparison operator against another value.

RegisterPdxSerializer()

static void Apache::Geode::Client::Serializable::RegisterPdxSerializer ( IPdxSerializer^  pdxSerializer )

staticinherited

Set the PDX serializer for the cache.

If this serializer is set, it will be consulted to see if it can serialize any domain classes which are added to the cache in portable data exchange format.

RegisterPdxType()

static void Apache::Geode::Client::Serializable::RegisterPdxType ( PdxTypeFactoryMethod^  creationMethod )

staticinherited

Register an instance factory method for a given type. This should be used when registering types that implement IPdxSerializable.

Parameters

creationMethod

the creation function to register

Exceptions

IllegalArgumentException

if the method is null

RegisterTypeGeneric()

static void Apache::Geode::Client::Serializable::RegisterTypeGeneric ( TypeFactoryMethodGeneric^  creationMethod )

staticinherited

Register an instance factory method for a given type.

This should be used when registering types that implement IGeodeSerializable.

Parameters

creationMethod

the creation function to register

Exceptions

IllegalArgumentException	if the method is null
IllegalStateException	if the typeId has already been registered, or there is an error in registering the type; check Utils::LastError for more information in the latter case.

SetPdxTypeMapper()

static void Apache::Geode::Client::Serializable::SetPdxTypeMapper ( IPdxTypeMapper^  pdxTypeMapper )

staticinherited

Register an PdxTypeMapper to map the local types to pdx types

Parameters

pdxTypeMapper

Object which implements IPdxTypeMapper interface

ToData()

virtual void Apache::Geode::Client::Serializable::ToData ( Apache::Geode::Client::DataOutput^  output )

virtualinherited

Serializes this native (C++) object.

Parameters

output

the DataOutput object to use for serializing the object

Implements Apache::Geode::Client::IGeodeSerializable.

Reimplemented 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 >, and Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableHashSet, apache::geode::client::CacheableHashSet >.

ToString()

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

virtual String ^ Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::ToString ( )

inlineoverridevirtual

Return a string representation of the object.

This returns the string for the Value property.

Reimplemented from Apache::Geode::Client::Serializable.

Property Documentation

ClassId

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

virtual System:: UInt32 Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::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.

Returns

the classId

ObjectSize

virtual System:: UInt32 Apache::Geode::Client::Serializable::ObjectSize

getinherited

return the size of this object in bytes

Value

template<typename TNative, typename TManaged, System::UInt32 TYPEID>

TManaged Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >::Value

get

Gets the value.