GemStone::GemFire::Cache::IRegionService Interface Reference

Inherited by GemStone::GemFire::Cache::IGemFireCache.


Detailed Description

A RegionService provides access to existing regions that exist in a Cache. Regions can be obtained using Cache.GetRegion and queried using <see cref="Cache.GetQueryService/>.

Caches are obtained from methods on the CacheFactory.Create class.

When a cache will no longer be used, call Cache.Close. Once it Cache.IsClosed any attempt to use it will cause a CacheClosedException to be thrown.

A cache can have multiple root regions, each with a different name.

Public Member Functions

void Close ()
QueryServiceGetQueryService ()
RegionGetRegion (String^ name)
array< Region^ >^ RootRegions ()

Properties

bool IsClosed [get]


Member Function Documentation

void GemStone::GemFire::Cache::IRegionService::Close (  ) 

Terminates this object cache and releases all the local resources. If RegionService is created from Cache.CreateAuthenticatedView, then it clears user related security data.

After this cache is closed, any further method call on this cache or any region object will throw CacheClosedException, unless otherwise noted.

Exceptions:
CacheClosedException if the cache is already closed.

Implemented in GemStone::GemFire::Cache::Cache.

QueryService ^ GemStone::GemFire::Cache::IRegionService::GetQueryService (  ) 

Get a query service object to be able to query the cache.

Currently only works against the java server in native mode, and at least some endpoints must have been defined in some regions before actually firing a query.

Implemented in GemStone::GemFire::Cache::Cache.

Region ^ GemStone::GemFire::Cache::IRegionService::GetRegion ( String^   name  ) 

Returns an existing region given the full path from root, or null if no such region exists.

Parameters:
name the name of the region
Returns:
the region

Implemented in GemStone::GemFire::Cache::Cache.

array<Region^> ^ GemStone::GemFire::Cache::IRegionService::RootRegions (  ) 

Returns an array of root regions in the cache. This set is a snapshot and is not backed by the cache.

It is not supported when Cache is created from Pool.

Returns:
array of regions

Implemented in GemStone::GemFire::Cache::Cache.


Property Documentation

bool GemStone::GemFire::Cache::IRegionService::IsClosed [get]

True if this cache has been closed.

After a new cache object is created, this method returns false. After Close is called on this cache object, this method returns true.

Returns:
true if this cache is closed, otherwise false

Implemented in GemStone::GemFire::Cache::Cache.


GemFire C++ Cache .NET API Documentation