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

An object in a Region that represents an entry, i.e., a key-value pair. More...

Inherits gemfire::SharedBase.

Public Member Functions

CacheableKeyPtr getKey ()
 Returns the key for this entry. More...
 
void getRegion (RegionPtr &region)
 Returns the region that contains this entry. More...
 
void getStatistics (CacheStatisticsPtr &csptr)
 Returns the statistics for this entry. More...
 
CacheablePtr getValue ()
 Returns the value of this entry in the local cache. More...
 
bool isDestroyed () const
 Returns whether this entry has been destroyed. More...
 
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 ~RegionEntry ()
 destructor More...
 

Detailed Description

An object in a Region that represents an entry, i.e., a key-value pair.

This object's operations are not distributed, do not acquire any locks, and do not affect CacheStatistics.

Unless otherwise noted, all of these methods throw a CacheClosedException if the Cache is closed at the time of invocation, or an EntryDestroyedException if the entry has been destroyed.

Constructor & Destructor Documentation

virtual gemfire::RegionEntry::~RegionEntry ( )
virtual

destructor

Member Function Documentation

CacheableKeyPtr gemfire::RegionEntry::getKey ( )

Returns the key for this entry.

Returns
the key for this entry
void gemfire::RegionEntry::getRegion ( RegionPtr region)

Returns the region that contains this entry.

Returns
the Region that contains this entry
void gemfire::RegionEntry::getStatistics ( CacheStatisticsPtr csptr)

Returns the statistics for this entry.

Returns
the CacheStatistics for this entry
Exceptions
StatisticsDisabledExceptionif statistics have been disabled for this region
CacheablePtr gemfire::RegionEntry::getValue ( )

Returns the value of this entry in the local cache.

Does not invoke a CacheLoader,

Returns
the value or NULLPTR if this entry is invalid
bool gemfire::RegionEntry::isDestroyed ( ) const

Returns whether this entry has been destroyed.

Does not throw a EntryDestroyedException if this entry has been destroyed.

Returns
true if this entry has been destroyed
void gemfire::SharedBase::preserveSB ( ) const
inherited

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount ( )
inlineinherited
Returns
the reference count
void gemfire::SharedBase::releaseSB ( ) const
inherited

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.


GemFire C++ Cache API Documentation