Caches are obtained from static methods on the CacheFactory class.
When a cache is created a DistributedSystem must be specified.
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 | |
virtual void | Close () |
virtual IPdxInstanceFactory^ | CreatePdxInstanceFactory (String^ className) |
template<class TKey, class TResult> | |
virtual QueryService < TKey, TResult >^ | GetQueryService () |
template<class TKey, class TValue> | |
virtual IRegion < TKey, TValue >^ | GetRegion (String^ path) |
template<class TKey, class TValue> | |
virtual array < IRegion< TKey, TValue >^>^ | RootRegions () |
Properties | |
virtual bool | IsClosed [get] |
virtual void GemStone::GemFire::Cache::Generic::AuthenticatedCache::Close | ( | ) | [virtual] |
Terminates this object cache and releases all the local resources. If Cache instance created from Pool(pool is in multiuser mode), then it reset 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.
CacheClosedException | if the cache is already closed. |
Implements GemStone::GemFire::Cache::Generic::IRegionService.
virtual IPdxInstanceFactory ^ GemStone::GemFire::Cache::Generic::AuthenticatedCache::CreatePdxInstanceFactory | ( | String^ | className | ) | [virtual] |
Returns a factory that can create a PdxInstance.
className | the fully qualified class name that the PdxInstance will become when it is fully deserialized. |
Implements GemStone::GemFire::Cache::Generic::IRegionService.
virtual QueryService<TKey, TResult> ^ GemStone::GemFire::Cache::Generic::AuthenticatedCache::GetQueryService | ( | ) | [explicit, virtual] |
Get a query service object to be able to query the cache. Supported only when cache is created from Pool(pool is in multiuserSecure mode)
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.
Implements GemStone::GemFire::Cache::Generic::IRegionService.
virtual IRegion<TKey, TValue> ^ GemStone::GemFire::Cache::Generic::AuthenticatedCache::GetRegion | ( | String^ | path | ) | [explicit, virtual] |
Returns an existing region given the full path from root, or null if no such region exists.
If Pool attached with Region is in multiusersecure mode then don't use return instance of region as no credential are attached with this instance. Get logical instance of region Pool->CreateSecureUserCache(<Credential>).getRegion(<name>) to do the operation on Cache.
path | the pathname of the region |
Implements GemStone::GemFire::Cache::Generic::IRegionService.
virtual array<IRegion<TKey, TValue>^> ^ GemStone::GemFire::Cache::Generic::AuthenticatedCache::RootRegions | ( | ) | [explicit, virtual] |
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.
Implements GemStone::GemFire::Cache::Generic::IRegionService.
virtual bool GemStone::GemFire::Cache::Generic::AuthenticatedCache::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.
Implements GemStone::GemFire::Cache::Generic::IRegionService.