VMware GemFire Native Client .NET Framework API Reference
|
VMware VMware GemFire Native .NET Reference 10.4.3
|
A RegionService provides access to existing regions that exist in a Cache. More...
#include <IRegionService.hpp>
Inherited by Apache::Geode::Client::IGeodeCache.
Public Member Functions | |
| void | Close () |
| Terminates this object cache and releases all the local resources. | |
| IPdxInstanceFactory ^ | CreatePdxInstanceFactory (String^ className) |
Returns a factory that can create a PdxInstance. | |
| Client::QueryService ^ | GetQueryService () |
| Get a query service object to be able to query the cache. | |
| template<class TKey , class TValue > | |
| IRegion< TKey, TValue > ^ | GetRegion (String^ name) |
| Returns an existing region given the full path from root, or null if no such region exists. | |
| template<class TKey , class TValue > | |
| array< IRegion< TKey, TValue >^> ^ | RootRegions () |
| Returns an array of root regions in the cache. | |
Properties | |
| bool | IsClosed [get] |
| True if this cache has been closed. | |
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/>.
<remarks>
Caches are obtained from methods on the
<see cref="CacheFactory.Create"/> class.
<para>
When a cache will no longer be used, call <see cref="Cache.Close" />.
Once it <see cref="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.
Member Function Documentation
◆ Close()
| void Apache::Geode::Client::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 Apache::Geode::Client::Cache.
◆ CreatePdxInstanceFactory()
| IPdxInstanceFactory ^ Apache::Geode::Client::IRegionService::CreatePdxInstanceFactory | ( | String^ | className | ) |
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 Apache::Geode::Client::Cache.
◆ GetQueryService()
| Client::QueryService ^ Apache::Geode::Client::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 Apache::Geode::Client::Cache.
◆ GetRegion()
| IRegion< TKey, TValue > ^ Apache::Geode::Client::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 Apache::Geode::Client::Cache.
◆ RootRegions()
| array< IRegion< TKey, TValue >^> ^ Apache::Geode::Client::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 Apache::Geode::Client::Cache.
Property Documentation
◆ 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
Apache Geode C++ Cache .NET API Documentation