gemfire_admin::CacheRegion Class Reference

Inherits gemfire::SharedBase.


Detailed Description

class to represent a CacheApplication Region Admin API class that represent's the CacheApplication's view of one of its Regions. Regions can also be sub-Regions of another region.

Author:
Jim Nist

Public Member Functions

virtual const bool getCachingEnabled ()=0
 Returns true if local caching is enabled.
virtual uint32_t getConcurrencyLevel ()=0
 Returns the ConcurrencyLevel.
virtual uint32_t getEntryCount ()=0
 Returns the number of entries currently in this Region.
virtual const char * getEntryIdleTimeoutAction ()=0
 Returns a description of the action taken when an Entry idle timeout is reached.
virtual uint32_t getEntryIdleTimeoutTimeout ()=0
 Returns the EntryIdleTimeout time limit.
virtual const char * getEntryTimeToLiveAction ()=0
 Returns a description of the action taken when an entry time-to-live timeout is reached.
virtual uint32_t getEntryTimeToLiveTimeout ()=0
 Returns the EntryTimeToLive time limit in milliseconds.
virtual const char * getFullPath ()=0
 Returns the full path name that identifies this Region in its cache.
virtual const bool getHasCacheListener ()=0
 Returns true if a CacheListener is associated with this Region.
virtual const bool getHasCacheLoader ()=0
 Returns true if a CacheLoader is associated with this Region.
virtual const bool getHasCacheWriter ()=0
 Returns true if a CacheWriter is associated with this Region.
virtual const char * getIdleTimeoutAction ()=0
 Returns a description of the action taken when an IdleTimeout timeout is reached.
virtual uint32_t getIdleTimeoutTimeout ()=0
 Returns the Region IdleTimeout time limit in milliseconds.
virtual uint32_t getInitialCapacity ()=0
 Returns the InitialCapacity .
virtual float getLoadFactor ()=0
 Returns the LoadFactor.
virtual uint32_t getLruEntriesLimit ()=0
 Returns the maximum number of entries allowed in this Region as part of the LRU scheme.
virtual const char * getLruEvictionAction ()=0
 Returns a description of the action taken when an entry is evicted under the LRU scheme.
virtual
MirrorType::Mirror 
getMirrorType ()=0
 Returns the MirrorType.
virtual const char * getName ()=0
virtual ScopeType::Scope getScope ()=0
 Returns the Scope .
virtual uint32_t getSubRegionCount ()=0
 Returns the number of SubRegions currently in this Region.
virtual void getSubRegions (VectorOfCacheRegion &sub_regions)=0
 Returns Regions belonging to this Region.
virtual const char * getTimeToLiveAction ()=0
 Returns a description of the action taken when a Region's time-to-live timeout is reached.
virtual uint32_t getTimeToLiveTimeout ()=0
 Returns the TimeToLive time limit.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

virtual void refresh (bool refreshSubregions)=0
 Retrieves this Region's Statistic resources.
void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
virtual void setEntryIdleTimeoutTimeout (uint32_t milliseconds)=0
 Sets the Region EntryIdleTimeout time limit.
virtual void setEntryTimeToLiveTimeout (uint32_t milliseconds)=0
 Sets the EntryTimeToLive time limit.
virtual void setIdleTimeoutTimeout (uint32_t milliseconds)=0
 Sets the Region IdleTimeout time limit.
virtual void setTimeToLiveTimeout (uint32_t milliseconds)=0
 Sets the TimeToLive time limit.

Member Function Documentation

virtual const bool gemfire_admin::CacheRegion::getCachingEnabled (  )  [pure virtual]

Returns true if local caching is enabled.

virtual uint32_t gemfire_admin::CacheRegion::getConcurrencyLevel (  )  [pure virtual]

Returns the ConcurrencyLevel.

virtual uint32_t gemfire_admin::CacheRegion::getEntryCount (  )  [pure virtual]

Returns the number of entries currently in this Region.

virtual const char* gemfire_admin::CacheRegion::getEntryIdleTimeoutAction (  )  [pure virtual]

Returns a description of the action taken when an Entry idle timeout is reached.

virtual uint32_t gemfire_admin::CacheRegion::getEntryIdleTimeoutTimeout (  )  [pure virtual]

Returns the EntryIdleTimeout time limit.

virtual const char* gemfire_admin::CacheRegion::getEntryTimeToLiveAction (  )  [pure virtual]

Returns a description of the action taken when an entry time-to-live timeout is reached.

virtual uint32_t gemfire_admin::CacheRegion::getEntryTimeToLiveTimeout (  )  [pure virtual]

Returns the EntryTimeToLive time limit in milliseconds.

virtual const char* gemfire_admin::CacheRegion::getFullPath (  )  [pure virtual]

Returns the full path name that identifies this Region in its cache.

@ see CacheRegion::getFullPath

virtual const bool gemfire_admin::CacheRegion::getHasCacheListener (  )  [pure virtual]

Returns true if a CacheListener is associated with this Region.

virtual const bool gemfire_admin::CacheRegion::getHasCacheLoader (  )  [pure virtual]

Returns true if a CacheLoader is associated with this Region.

virtual const bool gemfire_admin::CacheRegion::getHasCacheWriter (  )  [pure virtual]

Returns true if a CacheWriter is associated with this Region.

virtual const char* gemfire_admin::CacheRegion::getIdleTimeoutAction (  )  [pure virtual]

Returns a description of the action taken when an IdleTimeout timeout is reached.

virtual uint32_t gemfire_admin::CacheRegion::getIdleTimeoutTimeout (  )  [pure virtual]

Returns the Region IdleTimeout time limit in milliseconds.

virtual uint32_t gemfire_admin::CacheRegion::getInitialCapacity (  )  [pure virtual]

Returns the InitialCapacity .

virtual float gemfire_admin::CacheRegion::getLoadFactor (  )  [pure virtual]

Returns the LoadFactor.

virtual uint32_t gemfire_admin::CacheRegion::getLruEntriesLimit (  )  [pure virtual]

Returns the maximum number of entries allowed in this Region as part of the LRU scheme.

virtual const char* gemfire_admin::CacheRegion::getLruEvictionAction (  )  [pure virtual]

Returns a description of the action taken when an entry is evicted under the LRU scheme.

virtual MirrorType::Mirror gemfire_admin::CacheRegion::getMirrorType (  )  [pure virtual]

Returns the MirrorType.

virtual const char* gemfire_admin::CacheRegion::getName (  )  [pure virtual]

Methods Returns the name that identifies this Region in its cache.

@ see Region::getName

virtual ScopeType::Scope gemfire_admin::CacheRegion::getScope (  )  [pure virtual]

Returns the Scope .

virtual uint32_t gemfire_admin::CacheRegion::getSubRegionCount (  )  [pure virtual]

Returns the number of SubRegions currently in this Region.

virtual void gemfire_admin::CacheRegion::getSubRegions ( VectorOfCacheRegion sub_regions  )  [pure virtual]

Returns Regions belonging to this Region.

Parameters:
[out] sub_regions vector to return the list of subregions

virtual const char* gemfire_admin::CacheRegion::getTimeToLiveAction (  )  [pure virtual]

Returns a description of the action taken when a Region's time-to-live timeout is reached.

virtual uint32_t gemfire_admin::CacheRegion::getTimeToLiveTimeout (  )  [pure virtual]

Returns the TimeToLive time limit.

void gemfire::SharedBase::preserveSB (  )  const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount (  )  [inline, inherited]

Returns:
the reference count

virtual void gemfire_admin::CacheRegion::refresh ( bool  refreshSubregions  )  [pure virtual]

Retrieves this Region's Statistic resources.

Parameters:
[out] vectorOfStatisticResource vector of runtime Statistic resources Updates this Region getting current attributes and SubRegion information from its remote CacheApplication.
refreshSubregions whether to reload the list of SubRegions

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_admin::CacheRegion::setEntryIdleTimeoutTimeout ( uint32_t  milliseconds  )  [pure virtual]

Sets the Region EntryIdleTimeout time limit.

Parameters:
milliseconds time limit

virtual void gemfire_admin::CacheRegion::setEntryTimeToLiveTimeout ( uint32_t  milliseconds  )  [pure virtual]

Sets the EntryTimeToLive time limit.

Parameters:
milliseconds time limit

virtual void gemfire_admin::CacheRegion::setIdleTimeoutTimeout ( uint32_t  milliseconds  )  [pure virtual]

Sets the Region IdleTimeout time limit.

Parameters:
milliseconds time limit

virtual void gemfire_admin::CacheRegion::setTimeToLiveTimeout ( uint32_t  milliseconds  )  [pure virtual]

Sets the TimeToLive time limit.


GemFire C++ Cache API Documentation