gemfire::CacheableWideChar Class Reference

Inherits gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >.


Detailed Description

An immutable wrapper for wide-characters that can serve as a distributable key object for caching.

Public Member Functions

virtual int32_t classId () const
 Return the classId of the instance being serialized.
virtual int8_t DSFID () const
virtual SerializablefromData (DataInput &input)
 Deserialize this object from given DataInput.
virtual uint32_t hashcode () const
 Return the hashcode for this key.
virtual int32_t logString (char *buffer, int32_t maxLength) const
 Copy the string form of the object into a char* buffer for logging purposes.
virtual uint32_t objectSize () const
 Return the size in bytes of the instance being serialized.
bool operator== (const TObj other) const
 Return true if this key matches other key value.
virtual bool operator== (const CacheableKey &other) const
 Return true if this key matches other.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
virtual void toData (DataOutput &output) const
 Serialize this object to given DataOutput.
virtual
CacheableStringPtr 
toString () const
 Return a string representation of the object.
virtual int8_t typeId () const
 Return the typeId byte of the instance being serialized.
TObj value () const
 Gets the contained value.

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.
static
CacheableWideCharPtr 
create (const wchar_t value)
 Factory function to create an instance with the given value.
static
CacheableWideCharPtr 
create ()
 Factory function to create a new default instance.
static SerializablecreateDeserializable ()
 Factory function registered with serialization registry.
static void registerType (TypeFactoryMethod creationFunction)

Member Function Documentation

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual int32_t gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::classId (  )  const [inline, virtual, inherited]

Return the classId of the instance being serialized.

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

Implements gemfire::Serializable.

template<class PRIM>
static CacheableKeyPtr gemfire::CacheableKey::create ( const PRIM  value  )  [inline, static, inherited]

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.

Reimplemented from gemfire::Serializable.

static CacheableWideCharPtr gemfire::CacheableWideChar::create ( const wchar_t  value  )  [inline, static]

Factory function to create an instance with the given value.

static CacheableWideCharPtr gemfire::CacheableWideChar::create (  )  [inline, static]

Factory function to create a new default instance.

static Serializable* gemfire::CacheableWideChar::createDeserializable (  )  [inline, static]

Factory function registered with serialization registry.

virtual int8_t gemfire::Serializable::DSFID (  )  const [virtual, inherited]

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::CacheableUndefined, and gemfire::Struct.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual Serializable* gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::fromData ( DataInput input  )  [inline, virtual, inherited]

Deserialize this object from given DataInput.

Implements gemfire::Serializable.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual uint32_t gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::hashcode (  )  const [inline, virtual, inherited]

Return the hashcode for this key.

Implements gemfire::CacheableKey.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual int32_t gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::logString ( char *  buffer,
int32_t  maxLength 
) const [inline, virtual, inherited]

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

Reimplemented from gemfire::CacheableKey.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual uint32_t gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::objectSize (  )  const [inline, virtual, inherited]

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.

Reimplemented from gemfire::Serializable.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
bool gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::operator== ( const TObj  other  )  const [inline, inherited]

Return true if this key matches other key value.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual bool gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::operator== ( const CacheableKey other  )  const [inline, virtual, inherited]

Return true if this key matches other.

Implements gemfire::CacheableKey.

void gemfire::SharedBase::preserveSB (  )  const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount (  )  [inline, inherited]

Returns:
the reference count

static void gemfire::Serializable::registerType ( TypeFactoryMethod  creationFunction  )  [static, inherited]

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:
IllegalStateException if 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.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual void gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::toData ( DataOutput output  )  const [inline, virtual, inherited]

Serialize this object to given DataOutput.

Implements gemfire::Serializable.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual CacheableStringPtr gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::toString (  )  const [inline, virtual, inherited]

Return a string representation of the object.

Reimplemented from gemfire::Serializable.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
virtual int8_t gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::typeId (  )  const [inline, virtual, inherited]

Return the typeId byte of the instance being serialized.

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

Reimplemented from gemfire::Serializable.

template<typename TObj, int8_t TYPEID, const char * TYPENAME, const char * SPRINTFSYM, int32_t STRSIZE>
TObj gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >::value (  )  const [inline, inherited]

Gets the contained value.


GemFire C++ Cache API Documentation