Hazelcast C++ Client
Public Member Functions | Static Public Attributes | List of all members
hazelcast::client::internal::nearcache::NearCacheRecord< V > Class Template Referenceabstract

An expirable and evictable data object which represents a Near Cache entry. More...

#include <NearCacheRecord.h>

+ Inheritance diagram for hazelcast::client::internal::nearcache::NearCacheRecord< V >:

Public Member Functions

virtual void setValue (const boost::shared_ptr< V > &value)
 Sets the value of this NearCacheRecord. More...
 
virtual void setCreationTime (int64_t time)=0
 Sets the creation time of this Evictable in milliseconds. More...
 
virtual void setAccessTime (int64_t time)=0
 Sets the access time of this Evictable in milliseconds. More...
 
virtual void setAccessHit (int32_t hit)=0
 Sets the access hit count of this Evictable. More...
 
virtual void incrementAccessHit ()=0
 Increases the access hit count of this Evictable by. More...
 
virtual void resetAccessHit ()=0
 Resets the access hit count of this Evictable to. More...
 
virtual bool isIdleAt (int64_t maxIdleMilliSeconds, int64_t now)=0
 Checks whether the maximum idle time is passed with respect to the provided time without any access during this time period as. More...
 
virtual int64_t getInvalidationSequence () const =0
 
virtual void setInvalidationSequence (int64_t sequence)=0
 
virtual void setUuid (const boost::shared_ptr< util::UUID > &uuid)=0
 
virtual bool hasSameUuid (const boost::shared_ptr< util::UUID > &thatUuid) const =0
 
- Public Member Functions inherited from hazelcast::client::internal::eviction::Expirable
virtual int64_t getExpirationTime ()=0
 Gets the expiration time in milliseconds. More...
 
virtual void setExpirationTime (int64_t expirationTime)=0
 Sets the expiration time in milliseconds. More...
 
virtual bool isExpiredAt (int64_t now)=0
 Checks whether the expiration time is passed with respect to the provided time. More...
 
- Public Member Functions inherited from hazelcast::client::internal::eviction::Evictable< V >
virtual int64_t getCreationTime () const =0
 Gets the creation time of this Evictable in milliseconds. More...
 
virtual int64_t getLastAccessTime ()=0
 Gets the latest access time difference of this Evictable in milliseconds. More...
 
virtual int32_t getAccessHit ()=0
 Gets the access hit count of this Evictable. More...
 
virtual boost::shared_ptr< V > getValue () const
 Gets the value of this Evictable. More...
 

Static Public Attributes

static const int64_t TIME_NOT_SET = -1
 

Detailed Description

template<typename V>
class hazelcast::client::internal::nearcache::NearCacheRecord< V >

An expirable and evictable data object which represents a Near Cache entry.

Record of NearCacheRecordStore.

Parameters
<V>the type of the value stored by this NearCacheRecord
See also
com.hazelcast.internal.eviction.Expirable
com.hazelcast.internal.eviction.Evictable

Member Function Documentation

template<typename V >
virtual int64_t hazelcast::client::internal::nearcache::NearCacheRecord< V >::getInvalidationSequence ( ) const
pure virtual
Returns
last known invalidation sequence at time of this records' creation
template<typename V >
virtual bool hazelcast::client::internal::nearcache::NearCacheRecord< V >::hasSameUuid ( const boost::shared_ptr< util::UUID > &  thatUuid) const
pure virtual
Returns
true
if supplied uuid equals existing one, otherwise and when one of supplied or existing is null returns
false
template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::incrementAccessHit ( )
pure virtual

Increases the access hit count of this Evictable by.

1

.

template<typename V >
virtual bool hazelcast::client::internal::nearcache::NearCacheRecord< V >::isIdleAt ( int64_t  maxIdleMilliSeconds,
int64_t  now 
)
pure virtual

Checks whether the maximum idle time is passed with respect to the provided time without any access during this time period as.

maxIdleSeconds

.

Parameters
maxIdleMilliSecondsmaximum idle time in milliseconds
nowcurrent time in milliseconds
Returns
true
if exceeds max idle seconds, otherwise
false
template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::resetAccessHit ( )
pure virtual

Resets the access hit count of this Evictable to.

0

.

template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::setAccessHit ( int32_t  hit)
pure virtual

Sets the access hit count of this Evictable.

Parameters
hitthe access hit count for this Evictable
template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::setAccessTime ( int64_t  time)
pure virtual

Sets the access time of this Evictable in milliseconds.

Parameters
timethe latest access time of this Evictable in milliseconds
template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::setCreationTime ( int64_t  time)
pure virtual

Sets the creation time of this Evictable in milliseconds.

Parameters
timethe creation time for this Evictable in milliseconds
template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::setInvalidationSequence ( int64_t  sequence)
pure virtual
Parameters
sequencelast known invalidation sequence at time of this records' creation
template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::setUuid ( const boost::shared_ptr< util::UUID > &  uuid)
pure virtual
Parameters
uuidlast known uuid of invalidation source at time of this records' creation
template<typename V >
virtual void hazelcast::client::internal::nearcache::NearCacheRecord< V >::setValue ( const boost::shared_ptr< V > &  value)
inlinevirtual

Sets the value of this NearCacheRecord.

Parameters
valuethe value for this NearCacheRecord

The documentation for this class was generated from the following file: