A RegionService provides access to existing regions that exist in a GemFire cache.
More...
Inherits gemfire::SharedBase.
Inherited by gemfire::GemFireCache.
A RegionService provides access to existing regions that exist in a GemFire cache.
Regions can be obtained using getRegion and queried using getQueryService. The service should be closed to free up resources once it is no longer needed. Once it is closed any attempt to use it or any regions obtained from it will cause a CacheClosedException to be thrown.
Instances of the interface are created using one of the following methods:
| virtual void gemfire::RegionService::close |
( |
| ) |
|
|
pure virtual |
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.
Returns a factory that can create a PdxInstance.
- Parameters
-
| className | the fully qualified class name that the PdxInstance will become when it is fully deserialized. |
- Returns
- the factory
Implemented in gemfire::Cache.
| virtual RegionPtr gemfire::RegionService::getRegion |
( |
const char * |
name | ) |
|
|
pure virtual |
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 bool gemfire::RegionService::isClosed |
( |
| ) |
const |
|
pure virtual |
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 |
( |
| ) |
|
|
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.
| virtual void gemfire::RegionService::rootRegions |
( |
VectorOfRegion & |
regions | ) |
|
|
pure virtual |
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.
