gemfire::CacheableDate Class Reference

Inherits gemfire::CacheableKey.

---

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.

Public Member Functions
virtual int8_t	classId () const
virtual int	day () const
	Returns: day of the month.
virtual Serializable *	fromData (DataInput &input)
virtual uint32_t	hashcode () const
	Returns: the hashcode for this key.
virtual size_t	logString (char *buffer, size_t maxLength) const
	used to render as a string for logging.
virtual int64_t	milliseconds () const
	Returns: milliseconds elapsed as per epoch time.
virtual int	month () const
	Returns: month 1(Jan) - 12(Dec) .
virtual uint32_t	objectSize () const
	Returns: the size of the object in bytes
virtual bool	operator== (const CacheableKey &other) const
	Returns: 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
virtual CacheableStringPtr	toString () const
	Display this object as 'string', which depends on the implementation in the subclasses.
virtual int8_t	typeId () const
virtual int	year () const
	Returns: year, example 1999.
virtual	~CacheableDate ()
	Destructor.
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 CacheableDatePtr	create ()
	Factory method for creating an instance of CacheableDate.
static Serializable *	createDeserializable ()
static void	registerType (TypeFactoryMethod creationFunction)
Protected Member Functions
	CacheableDate (const time_t value=0)
	Constructor, used for deserialization.
	CacheableDate (const timeval &value)
	Constructor, given a timeval 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 int8_t gemfire::CacheableDate::classId

(

)

const [virtual]

Return the classId byte of the instance being serialized. This is used by deserialization to determine what instance type to create and derserialize 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 CacheableDatePtr gemfire::CacheableDate::create

(

)

[inline, static]

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 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 size_t gemfire::CacheableDate::logString	(	char *	buffer,
		size_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 [inline, virtual]

Returns:

the size of the object in bytes

Implements 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

(

)

[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::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.

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 derserialize into.

Reimplemented from gemfire::Serializable.

virtual int gemfire::CacheableDate::year

(

)

const [virtual]

Returns:

year, example 1999.

---