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

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

Inherited by GemStone::GemFire::Cache::Generic::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 ()
IPdxInstanceFactoryCreatePdxInstanceFactory (String^ className)
bool GetPdxIgnoreUnreadFields ()
 summary> Returns whether PdxInstance is preferred for PDX types instead of .NET object.
template<class TKey, class TResult>
Generic::QueryService
< TKey, TResult >^ 
GetQueryService ()
template<class TKey, class TValue>
IRegion< TKey, TValue >^ GetRegion (String^ name)
void InitializeDeclarativeCache (String^ cacheXml)
template<class TKey, class TValue>
array< IRegion< TKey,
TValue >^>^ 
RootRegions ()

Properties

GemStone::GemFire::Cache::Generic::CacheTransactionManager^  CacheTransactionManager [get]
DistributedSystem^  DistributedSystem [get]
bool IsClosed [get]
String^  Name [get]


Member Function Documentation

void GemStone::GemFire::Cache::Generic::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::Generic::Cache, and GemStone::GemFire::Cache::Generic::AuthenticatedCache.

IPdxInstanceFactory ^ GemStone::GemFire::Cache::Generic::IRegionService::CreatePdxInstanceFactory ( String^   className  )  [inherited]

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 GemStone::GemFire::Cache::Generic::Cache, and GemStone::GemFire::Cache::Generic::AuthenticatedCache.

bool GemStone::GemFire::Cache::Generic::IGemFireCache::GetPdxIgnoreUnreadFields (  ) 

summary> Returns whether PdxInstance is preferred for PDX types instead of .NET object.

/summary>

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

template<class TKey, class TResult>
Generic::QueryService<TKey, TResult> ^ GemStone::GemFire::Cache::Generic::IRegionService::GetQueryService (  )  [explicit, 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::Generic::Cache, and GemStone::GemFire::Cache::Generic::AuthenticatedCache.

template<class TKey, class TValue>
IRegion<TKey, TValue> ^ GemStone::GemFire::Cache::Generic::IRegionService::GetRegion ( String^   name  )  [explicit, 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::Generic::Cache, and GemStone::GemFire::Cache::Generic::AuthenticatedCache.

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

Initializes the cache from an XML file.

Parameters:
cacheXml pathname of a cache.xml file

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

template<class TKey, class TValue>
array<IRegion<TKey, TValue>^> ^ GemStone::GemFire::Cache::Generic::IRegionService::RootRegions (  )  [explicit, 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::Generic::Cache, and GemStone::GemFire::Cache::Generic::AuthenticatedCache.


Property Documentation

GemStone:: GemFire:: Cache:: Generic:: CacheTransactionManager^ GemStone::GemFire::Cache::Generic::IGemFireCache::CacheTransactionManager [get]

Returns the cache transaction manager of CacheFactory.Create this cache.summary> Returns whether Cache saves unread fields for Pdx types. /summary>

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

DistributedSystem^ GemStone::GemFire::Cache::Generic::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::Generic::Cache.

bool GemStone::GemFire::Cache::Generic::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::Generic::Cache, and GemStone::GemFire::Cache::Generic::AuthenticatedCache.

String^ GemStone::GemFire::Cache::Generic::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::Generic::Cache.


GemFire C++ Cache .NET API Documentation