Pivotal GemFire Native Client Cache Reference  9.0.6
gemfire::CacheableDate Class Reference

Implement a date object based on system epoch that can serve as a distributable key object for caching as well as being a date value. More...

Inherits gemfire::CacheableKey.

Public Member Functions

virtual int32_t classId () const
 Return the classId of the instance being serialized. More...
 
virtual int day () const
 
virtual int8_t DSFID () const
 return the Data Serialization Fixed ID type. More...
 
virtual SerializablefromData (DataInput &input)
 deserialize this object More...
 
virtual uint32_t hashcode () const
 
virtual int32_t logString (char *buffer, int32_t maxLength) const
 used to render as a string for logging. More...
 
virtual int64_t milliseconds () const
 
virtual int month () const
 
virtual uint32_t objectSize () const
 
virtual bool operator== (const CacheableKey &other) const
 
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
 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...
 
virtual int year () const
 
virtual ~CacheableDate ()
 Destructor. 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 CacheableDatePtr create ()
 Factory method for creating an instance of CacheableDate. More...
 
static SerializablecreateDeserializable ()
 creation function for dates. 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

 CacheableDate (const timeval &value)
 Constructor, given a timeval value. More...
 
 CacheableDate (const time_t value=0)
 Constructor, used for deserialization. More...
 

Detailed Description

Implement a date object based on system epoch that can serve as a distributable key object for caching as well as being a date value.

Constructor & Destructor Documentation

virtual gemfire::CacheableDate::~CacheableDate ( )
virtual

Destructor.

gemfire::CacheableDate::CacheableDate ( const timeval &  value)
protected

Constructor, given a timeval value.

gemfire::CacheableDate::CacheableDate ( const time_t  value = 0)
protected

Constructor, used for deserialization.

Member Function Documentation

virtual int32_t gemfire::CacheableDate::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 CacheableKeyPtr gemfire::CacheableKey::create ( const PRIM  value)
inlinestaticinherited

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.

static CacheableDatePtr gemfire::CacheableDate::create ( )
inlinestatic

Factory method for creating an instance of CacheableDate.

static Serializable* gemfire::CacheableDate::createDeserializable ( )
static

creation function for dates.

virtual int gemfire::CacheableDate::day ( ) const
virtual
Returns
day of the month.
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 Serializable* gemfire::CacheableDate::fromData ( DataInput input)
virtual

deserialize this object

Implements gemfire::Serializable.

virtual uint32_t gemfire::CacheableDate::hashcode ( ) const
virtual
Returns
the hashcode for this key.

Implements gemfire::CacheableKey.

virtual int32_t gemfire::CacheableDate::logString ( char *  buffer,
int32_t  maxLength 
) const
virtual

used to render as a string for logging.

Reimplemented from gemfire::CacheableKey.

virtual int64_t gemfire::CacheableDate::milliseconds ( ) const
virtual
Returns
milliseconds elapsed as per epoch time.
virtual int gemfire::CacheableDate::month ( ) const
virtual
Returns
month 1(Jan) - 12(Dec) .
virtual uint32_t gemfire::CacheableDate::objectSize ( ) const
inlinevirtual
Returns
the size of the object in bytes

Reimplemented from gemfire::Serializable.

virtual bool gemfire::CacheableDate::operator== ( const CacheableKey other) const
virtual
Returns
true if this key matches other.

Implements gemfire::CacheableKey.

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 void gemfire::CacheableDate::toData ( DataOutput output) const
virtual

serialize this object

Implements gemfire::Serializable.

virtual CacheableStringPtr gemfire::CacheableDate::toString ( ) const
virtual

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

virtual int8_t gemfire::CacheableDate::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.

virtual int gemfire::CacheableDate::year ( ) const
virtual
Returns
year, example 1999.

GemFire C++ Cache API Documentation