GemStone::GemFire::Cache::IGemFireCache Interface Reference

Inherits GemStone::GemFire::Cache::IRegionService.

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


Detailed Description

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

Caches are obtained from Crest methods on the CacheFactory.Create 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

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

Properties

DistributedSystem^  DistributedSystem [get]
bool IsClosed [get]
String^  Name [get]


Member Function Documentation

void GemStone::GemFire::Cache::IRegionService::Close (  )  [inherited]

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 (  )  [inherited]

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  )  [inherited]

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.

void GemStone::GemFire::Cache::IGemFireCache::InitializeDeclarativeCache ( String^   cacheXml  ) 

Initializes the cache from an XML file.

Parameters:
cacheXml pathname of a cache.xml file

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

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

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

DistributedSystem^ GemStone::GemFire::Cache::IGemFireCache::DistributedSystem [get]

Returns the distributed system used to CacheFactory.Create this cache.

This method does not throw CacheClosedException if the cache is closed.

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

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

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.

String^ GemStone::GemFire::Cache::IGemFireCache::Name [get]

Returns the name of this cache.

This method does not throw CacheClosedException if the cache is closed.

Returns:
the string name of this cache

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


GemFire C++ Cache .NET API Documentation