Pivotal GemFire Native Client Cache Reference  9.0.6
gemfire::CacheableKey Class Referenceabstract

Represents a cacheable key. More...

Inherits gemfire::Serializable.

Inherited by gemfire::CacheableDate, gemfire::CacheableEnum, gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, gemfire::CacheableString, and gemfire::PdxSerializable.

Public Member Functions

virtual int32_t classId () const =0
 Return the classId of the instance being serialized. More...
 
virtual int8_t DSFID () const
 return the Data Serialization Fixed ID type. More...
 
virtual SerializablefromData (DataInput &input)=0
 deserialize this object, typical implementation should return the 'this' pointer. More...
 
virtual uint32_t hashcode () const =0
 return the hashcode for this key. More...
 
virtual int32_t logString (char *buffer, int32_t maxLength) const
 Copy the string form of a key into a char* buffer for logging purposes. More...
 
virtual uint32_t objectSize () const
 return the size in bytes of the instance being serialized. More...
 
virtual bool operator== (const CacheableKey &other) const =0
 return true if this key matches other. More...
 
void preserveSB () const
 Atomically increment reference count. More...
 
int32_t refCount ()
 
void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. More...
 
virtual void toData (DataOutput &output) const =0
 serialize this object More...
 
virtual CacheableStringPtr toString () const
 Display this object as 'string', which depends on the implementation in the subclasses. More...
 
virtual int8_t typeId () const
 return the typeId byte of the instance being serialized. More...
 

Static Public Member Functions

template<class PRIM >
static CacheableKeyPtr create (const PRIM value)
 Factory method that creates the key type that matches the type of value. More...
 
static void registerPdxSerializer (PdxSerializerPtr pdxSerializer)
 Register the PDX serializer which can handle serialization for instances of user domain classes. More...
 
static void registerPdxType (TypeFactoryMethodPdx creationFunction)
 register an Pdx instance factory method for a given type. More...
 
static void registerType (TypeFactoryMethod creationFunction)
 register an instance factory method for a given type. More...
 

Protected Member Functions

 CacheableKey ()
 Constructor. More...
 
virtual ~CacheableKey ()
 Destructor. More...
 

Detailed Description

Represents a cacheable key.

Constructor & Destructor Documentation

gemfire::CacheableKey::CacheableKey ( )
inlineprotected

Constructor.

virtual gemfire::CacheableKey::~CacheableKey ( )
inlineprotectedvirtual

Destructor.

Member Function Documentation

virtual int32_t gemfire::Serializable::classId ( ) const
pure virtualinherited

Return 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. Using a negative value may result in undefined behavior.

Implemented in gemfire::CacheableContainerType< TBase, TYPEID >, gemfire::CacheableArrayType< TObj, TYPEID >, gemfire::RegionAttributes, gemfire::Properties, gemfire::Struct, gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, gemfire::CacheableString, gemfire::CacheableEnum, gemfire::CacheableDate, gemfire::UserFunctionExecutionException, gemfire::CacheableObjectArray, gemfire::CacheableUndefined, and gemfire::CacheableFileName.

template<class PRIM >
static CacheableKeyPtr gemfire::CacheableKey::create ( const PRIM  value)
inlinestatic

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

For customer defined derivations of CacheableKey, the method gemfire::createKey may be overloaded. For pointer types (e.g. char*) the method gemfire::createKeyArr may be overloaded.

virtual int8_t gemfire::Serializable::DSFID ( ) const
virtualinherited

return the Data Serialization Fixed ID type.

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

Note that this should not be overridden by custom implementations and is reserved only for builtin types.

Reimplemented in gemfire::Struct, and gemfire::CacheableUndefined.

virtual uint32_t gemfire::CacheableKey::hashcode ( ) const
pure virtual
virtual int32_t gemfire::CacheableKey::logString ( char *  buffer,
int32_t  maxLength 
) const
virtual

Copy the string form of a key into a char* buffer for logging purposes.

Implementations should only generate a string as long as maxLength chars, and return the number of chars written. buffer is expected to be large enough to hold at least maxLength chars.

The default implementation renders the classname and instance address.

Reimplemented in gemfire::CacheableString, gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, and gemfire::CacheableDate.

virtual uint32_t gemfire::Serializable::objectSize ( ) const
virtualinherited

return the size in bytes of the instance being serialized.

This is used to determine whether the cache is using up more physical memory than it has been configured to use. The method can return zero if the user does not require the ability to control cache memory utilization. Note that you must implement this only if you use the HeapLRU feature.

Reimplemented in gemfire::PdxInstance, gemfire::CacheableContainerType< TBase, TYPEID >, gemfire::CacheableArrayType< TObj, TYPEID >, gemfire::CacheableString, gemfire::RegionAttributes, gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, gemfire::Properties, gemfire::Struct, gemfire::CacheableObjectArray, gemfire::CacheableUndefined, gemfire::CacheableDate, gemfire::UserFunctionExecutionException, and gemfire::CacheableEnum.

virtual bool gemfire::CacheableKey::operator== ( const CacheableKey other) const
pure virtual
void gemfire::SharedBase::preserveSB ( ) const
inherited

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount ( )
inlineinherited
Returns
the reference count
static void gemfire::Serializable::registerPdxSerializer ( PdxSerializerPtr  pdxSerializer)
staticinherited

Register the PDX serializer which can handle serialization for instances of user domain classes.

See also
PdxSerializer
static void gemfire::Serializable::registerPdxType ( TypeFactoryMethodPdx  creationFunction)
staticinherited

register an Pdx instance factory method for a given type.

Exceptions
IllegalStateExceptionif the typeName has already been registered, or there is an error in registering the type; check errno for more information in the latter case.
static void gemfire::Serializable::registerType ( TypeFactoryMethod  creationFunction)
staticinherited

register an instance factory method for a given type.

During registration the factory will be invoked to extract the typeId to associate with this function.

Exceptions
IllegalStateExceptionif the typeId has already been registered, or there is an error in registering the type; check errno for more information in the latter case.
void gemfire::SharedBase::releaseSB ( ) const
inherited

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

virtual CacheableStringPtr gemfire::Serializable::toString ( ) const
virtualinherited

Display this object as 'string', which depends on the implementation in the subclasses.

The default implementation renders the classname.

The return value may be a temporary, so the caller has to ensure that the SharedPtr count does not go down to zero by storing the result in a variable or otherwise.

Reimplemented in gemfire::PdxInstance, gemfire::CacheableString, gemfire::CacheableDate, gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, and gemfire::CacheableEnum.

virtual int8_t gemfire::Serializable::typeId ( ) const
virtualinherited

return the typeId byte of the instance being serialized.

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

Note that this should not be overridden by custom implementations and is reserved only for builtin types.

Reimplemented in gemfire::CacheableContainerType< TBase, TYPEID >, gemfire::CacheableArrayType< TObj, TYPEID >, gemfire::RegionAttributes, gemfire::Properties, gemfire::Struct, gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, gemfire::CacheableString, gemfire::UserFunctionExecutionException, gemfire::CacheableEnum, gemfire::CacheableDate, gemfire::CacheableObjectArray, gemfire::CacheableUndefined, and gemfire::CacheableFileName.


GemFire C++ Cache API Documentation