GemStone::GemFire::Cache::Generic::IRegion< TKey, TValue > Interface Template Reference

Inherited by GemStone::GemFire::Cache::Generic::LocalRegion< TKey, TValue >, and GemStone::GemFire::Cache::Generic::Region< TKey, TValue >.

Detailed Description

template<class TKey, class TValue>
interface GemStone::GemFire::Cache::Generic::IRegion< TKey, TValue >

Encapsulates a concrete region of cached data. Implements generic IDictionary<TKey, TValue> interface class.

This class manages subregions and cached data. Each region can contain multiple subregions and entries for data. Regions provide a hierachical name space within the cache. Also, a region can be used to group cached objects for management purposes.

Entries managed by the region are key-value pairs. A set of region attributes is associated with the region when it is created.

The IRegion interface basically contains two set of APIs: Region management APIs and (potentially) distributed operations on entries. Non-distributed operations on entries are provided by RegionEntry.

Each Cache defines regions called the root regions. User applications can use the root regions to create subregions for isolated name spaces and object grouping.

A region's name can be any string, except that it must not contain the region name separator, a forward slash (/).

Regions can be referenced by a relative path name from any region higher in the hierarchy in IRegion.GetSubRegion. You can get the relative path from the root region with IRegion.FullPath. The name separator is used to concatenate all the region names together from the root, starting with the root's subregions.


GemFire C++ Cache .NET API Documentation