gemfire::CacheableUndefined Class Reference

Inherits gemfire::Serializable.


Detailed Description

Encapsulate an undefined query result.

Public Member Functions

virtual int32_t classId () const
virtual int8_t DSFID () const
virtual SerializablefromData (DataInput &input)
virtual uint32_t objectSize () const
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
virtual
CacheableStringPtr 
toString () const
 Display this object as 'string', which depends on the implementation in the subclasses.
virtual int8_t typeId () const

Static Public Member Functions

template<class PRIM>
static SerializablePtr create (const PRIM value)
 Factory method that creates the Serializable object that matches the type of value.
static
CacheableUndefinedPtr 
create ()
 Factory method for creating the default instance of CacheableUndefined.
static SerializablecreateDeserializable ()
static void registerType (TypeFactoryMethod creationFunction)

Protected Member Functions

 CacheableUndefined ()
 Constructor, used for deserialization.

Constructor & Destructor Documentation

gemfire::CacheableUndefined::CacheableUndefined (  )  [inline, protected]

Constructor, used for deserialization.


Member Function Documentation

virtual int32_t gemfire::CacheableUndefined::classId (  )  const [virtual]

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 SerializablePtr gemfire::Serializable::create ( const PRIM  value  )  [inline, static, inherited]

Factory method that creates the Serializable object that matches the type of value.

For customer defined derivations of Serializable, the method gemfire::createValue may be overloaded. For pointer types (e.g. char*) the method gemfire::createValueArr may be overloaded.

Reimplemented in gemfire::CacheableKey.

static CacheableUndefinedPtr gemfire::CacheableUndefined::create (  )  [inline, static]

Factory method for creating the default instance of CacheableUndefined.

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

creation function for undefined query result

virtual int8_t gemfire::CacheableUndefined::DSFID (  )  const [virtual]

Return the data serialization fixed ID size type for internal use.

Since:
GFE 5.7

Reimplemented from gemfire::Serializable.

virtual Serializable* gemfire::CacheableUndefined::fromData ( DataInput input  )  [virtual]

deserialize this object

Implements gemfire::Serializable.

virtual uint32_t gemfire::CacheableUndefined::objectSize (  )  const [virtual]

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 from gemfire::Serializable.

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.

virtual void gemfire::CacheableUndefined::toData ( DataOutput output  )  const [virtual]

serialize this object

Implements gemfire::Serializable.

virtual CacheableStringPtr gemfire::Serializable::toString (  )  const [virtual, inherited]

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::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, gemfire::CacheableDate, and gemfire::CacheableString.

virtual int8_t gemfire::CacheableUndefined::typeId (  )  const [virtual]

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.


GemFire C++ Cache API Documentation