gemfire::GemFireCache Class Reference

Inherits gemfire::RegionService.

Inherited by gemfire::Cache.


Detailed Description

GemFireCache represents the singleton cache that must be created in order to connect to Gemfire server.

Users must create a Cache. Instances of this interface are created using one of the following methods:


Public Member Functions

virtual void close ()=0
 Terminates this object cache and releases all the local resources.
virtual
DistributedSystemPtr 
getDistributedSystem () const =0
 Returns the distributed system that this cache was created with.
virtual const char * getName () const =0
virtual bool getPdxIgnoreUnreadFields ()=0
 Returns whther Cache saves unread fields for Pdx types.
virtual QueryServicePtr getQueryService ()=0
 Gets the QueryService from which a new Query can be obtained.
virtual RegionPtr getRegion (const char *name)=0
 Look up a region with the name.
virtual void initializeDeclarativeCache (const char *cacheXml)=0
 Initializes the cache from an xml file.
virtual bool isClosed () const =0
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 rootRegions (VectorOfRegion &regions)=0
 Returns a set of root regions in the cache.

Member Function Documentation

virtual void gemfire::RegionService::close (  )  [pure virtual, inherited]

Terminates this object cache and releases all the local resources.

After this cache is closed, any further method call on this cache or any region object will throw CacheClosedException, unless otherwise noted. If RegionService is created from Cache#createAuthenticatedView", then it clears user related security data.

Parameters:
keepalive whether to keep a durable CQ kept alive for this user.
Exceptions:
CacheClosedException,if the cache is already closed.

Implemented in gemfire::Cache.

virtual DistributedSystemPtr gemfire::GemFireCache::getDistributedSystem (  )  const [pure virtual]

Returns the distributed system that this cache was created with.

Implemented in gemfire::Cache.

virtual const char* gemfire::GemFireCache::getName (  )  const [pure virtual]

public methods Returns the name of this cache.

Returns:
the string name of this cache

Implemented in gemfire::Cache.

virtual bool gemfire::GemFireCache::getPdxIgnoreUnreadFields (  )  [pure virtual]

Returns whther Cache saves unread fields for Pdx types.

Currently c++ don't support pdx types, thus it is for internal purpose only

Implemented in gemfire::Cache.

virtual QueryServicePtr gemfire::RegionService::getQueryService (  )  [pure virtual, inherited]

Gets the QueryService from which a new Query can be obtained.

Returns:
A smart pointer to the QueryService.

Implemented in gemfire::Cache.

virtual RegionPtr gemfire::RegionService::getRegion ( const char *  name  )  [pure virtual, inherited]

Look up a region with the name.

Parameters:
name the region's name, such as root.
Returns:
region, or NULLPTR if no such region exists.

Implemented in gemfire::Cache.

virtual void gemfire::GemFireCache::initializeDeclarativeCache ( const char *  cacheXml  )  [pure virtual]

Initializes the cache from an xml file.

Parameters:
cacheXml Valid cache.xml file

Implemented in gemfire::Cache.

virtual bool gemfire::RegionService::isClosed (  )  const [pure virtual, inherited]

public methods Indicates if this cache has been closed. After a new cache object is created, this method returns false; After the close is called on this cache object, this method returns true.

Returns:
true, if this cache is closed; false, otherwise

Implemented in gemfire::Cache.

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

Atomically increment reference count.

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

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.

virtual void gemfire::RegionService::rootRegions ( VectorOfRegion regions  )  [pure virtual, inherited]

Returns a set of root regions in the cache.

This set is a snapshot and is not backed by the Cache. The vector passed in is cleared and the regions are added to it.

Parameters:
regions the returned set of regions

Implemented in gemfire::Cache.


GemFire C++ Cache API Documentation