| Region Class |
Note: This API is now obsolete.
Encapsulates a concrete region of cached data.
Inheritance HierarchySystem.Object
[T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Region>]
GemStone.GemFire.Cache.Region
[T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Region>]
GemStone.GemFire.Cache.Region
Namespace: GemStone.GemFire.Cache
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18
SyntaxThe Region type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Attributes |
Returns the attributes for this region, which can be used to create a new
region with [!:Cache.CreateRegion].
|
| Cache |
Gets the cache for this region.
|
| FullPath |
Gets the region's full path, which can be used to get this region object
with [!:Cache.GetRegion].
|
| IsDestroyed |
True if this region has been destroyed.
|
| Name |
Gets the region name.
|
| ParentRegion |
Gets the parent region.
|
| RegionService |
Gets the RegionService for this region.
|
| Size |
Get the size of region. For native client regions, this will give
the number of entries in the local cache and not on the servers.
|
| Statistics |
Returns the statistics for this region.
|
Methods| Name | Description | |
|---|---|---|
 | Clear() |
remove all entries in the local region
|
| Clear(IGFSerializable) |
remove all entries in the local region
|
| ContainsKey(CacheableKey) |
True if the region contains the given key.
This only searches in the local cache.
|
| ContainsKey(ICacheableKey) |
True if the region contains the given key.
This only searches in the local cache.
|
| ContainsKeyOnServer |
check to see if the key is present on the server
|
| ContainsValueForKey(CacheableKey) |
True if the region contains a value for the given key.
This only searches in the local cache.
|
| ContainsValueForKey(ICacheableKey) |
True if the region contains a value for the given key.
This only searches in the local cache.
|
| Create(CacheableKey, IGFSerializable) |
Creates a new entry in this region with the specified key and value.
|
| Create(CacheableKey, Serializable) |
Creates a new entry in this region with the specified key and value.
|
| Create(ICacheableKey, IGFSerializable) |
Creates a new entry in this region with the specified key and value.
|
| Create(ICacheableKey, Serializable) |
Creates a new entry in this region with the specified key and value.
|
| Create(CacheableKey, IGFSerializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| Create(CacheableKey, Serializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| Create(ICacheableKey, IGFSerializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| Create(ICacheableKey, Serializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| CreateSubRegion |
Creates a subregion with the given name and attributes.
|
| Destroy(CacheableKey) |
Destroys the entry with the specified key, passing the callback
argument to any cache writers that are invoked in the operation.
|
| Destroy(ICacheableKey) |
Destroys the entry with the specified key, passing the callback
argument to any cache writers that are invoked in the operation.
|
| Destroy(CacheableKey, IGFSerializable) |
Destroys the entry with the specified key, passing the callback
argument to any cache writers that are invoked in the operation.
|
| Destroy(ICacheableKey, IGFSerializable) |
Destroys the entry with the specified key, passing the callback
argument to any cache writers that are invoked in the operation.
|
| DestroyRegion() |
Destroys the whole distributed region and provides a user-defined parameter
object to any ICacheWriter invoked in the process.
|
| DestroyRegion(IGFSerializable) |
Destroys the whole distributed region and provides a user-defined parameter
object to any ICacheWriter invoked in the process.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExistsValue(String) |
Executes the query on the server based on the predicate
and returns whether any result exists.
Valid only for a Native Client region.
|
| ExistsValue(String, UInt32) |
Executes the query on the server based on the predicate
and returns whether any result exists.
Valid only for a Native Client region.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Get(CacheableKey) |
Returns the value for the given key, passing the callback argument
to any cache loaders or that are invoked in the operation.
|
| Get(ICacheableKey) |
Returns the value for the given key, passing the callback argument
to any cache loaders or that are invoked in the operation.
|
| Get(CacheableKey, IGFSerializable) |
Returns the value for the given key, passing the callback argument
to any cache loaders or that are invoked in the operation.
|
| Get(ICacheableKey, IGFSerializable) |
Returns the value for the given key, passing the callback argument
to any cache loaders or that are invoked in the operation.
|
| GetAll(CacheableKey[], Dictionary<ICacheableKey, IGFSerializable>, Dictionary<ICacheableKey, Exception>) | |
| GetAll(ICacheableKey[], Dictionary<ICacheableKey, IGFSerializable>, Dictionary<ICacheableKey, Exception>) | |
| GetAll(CacheableKey[], Dictionary<ICacheableKey, IGFSerializable>, Dictionary<ICacheableKey, Exception>, Boolean) | |
| GetAll(ICacheableKey[], Dictionary<ICacheableKey, IGFSerializable>, Dictionary<ICacheableKey, Exception>, Boolean) | |
| GetAttributesMutator |
Return a mutator object for changing a subset of the
region attributes.
|
| GetEntries |
Gets the entries in this region.
|
| GetEntry(CacheableKey) |
Return the meta-object RegionEntry for the given key.
|
| GetEntry(ICacheableKey) |
Return the meta-object RegionEntry for the given key.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInterestList |
get the interest list on this client
|
| GetInterestListRegex |
get the list of interest regular expressions on this client
|
| GetKeys |
Returns all the keys in the local process for this region. This includes
keys for which the entry is invalid.
|
| GetServerKeys |
Returns the set of keys defined in the server process associated with this
client and region. If a server has the region defined as a mirror, then
this will be the entire keyset for the region across all server
Peers in the distributed system.
|
| GetSubRegion |
Returns the subregion identified by the path, null if no such subregion.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValues |
Returns all values in the local process for this region. No value is included
for entries that are invalidated.
|
| Invalidate(CacheableKey) |
Invalidates the entry with the specified key, passing the callback
argument to any cache listeners that are invoked in the operation.
|
| Invalidate(ICacheableKey) |
Invalidates the entry with the specified key, passing the callback
argument to any cache listeners that are invoked in the operation.
|
| Invalidate(CacheableKey, IGFSerializable) |
Invalidates the entry with the specified key,
passing the callback argument
to any cache
listeners that are invoked in the operation.
|
| Invalidate(ICacheableKey, IGFSerializable) |
Invalidates the entry with the specified key,
passing the callback argument
to any cache
listeners that are invoked in the operation.
|
| InvalidateRegion() |
Invalidates this region.
|
| InvalidateRegion(IGFSerializable) |
Invalidates this region.
|
| LocalClear() |
remove all entries in the local region
|
| LocalClear(IGFSerializable) |
remove all entries in the local region
|
| LocalCreate(CacheableKey, IGFSerializable) |
Creates a new entry in this region with the specified key and value
in the local cache only.
|
| LocalCreate(CacheableKey, Serializable) |
Creates a new entry in this region with the specified key and value
in the local cache only.
|
| LocalCreate(ICacheableKey, IGFSerializable) |
Creates a new entry in this region with the specified key and value
in the local cache only.
|
| LocalCreate(ICacheableKey, Serializable) |
Creates a new entry in this region with the specified key and value
in the local cache only.
|
| LocalCreate(CacheableKey, IGFSerializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value
in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalCreate(CacheableKey, Serializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value
in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalCreate(ICacheableKey, IGFSerializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value
in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalCreate(ICacheableKey, Serializable, IGFSerializable) |
Creates a new entry in this region with the specified key and value
in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalDestroy(CacheableKey) |
Destroys the value with the specified key in the local cache only.
Destroy removes not only the value but also the key and entry
from this region.
|
| LocalDestroy(ICacheableKey) |
Destroys the value with the specified key in the local cache only.
Destroy removes not only the value but also the key and entry
from this region.
|
| LocalDestroy(CacheableKey, IGFSerializable) |
Destroys the value with the specified key in the local cache only.
Destroy removes not only the value but also the key and entry
from this region.
|
| LocalDestroy(ICacheableKey, IGFSerializable) |
Destroys the value with the specified key in the local cache only.
Destroy removes not only the value but also the key and entry
from this region.
|
| LocalDestroyRegion() |
Destroys the whole local region and provides a user-defined parameter
object to any ICacheWriter invoked in the process.
The region destroy is not distributed to other caches.
|
| LocalDestroyRegion(IGFSerializable) |
Destroys the whole local region and provides a user-defined parameter
object to any ICacheWriter invoked in the process.
The region destroy is not distributed to other caches.
|
| LocalInvalidate(CacheableKey) |
Locally invalidates the entry with the specified key, passing the
callback argument to any cache listeners that are invoked in the operation.
|
| LocalInvalidate(ICacheableKey) |
Locally invalidates the entry with the specified key, passing the
callback argument to any cache listeners that are invoked in the operation.
|
| LocalInvalidate(CacheableKey, IGFSerializable) |
Locally invalidates the entry with the specified key, passing the
callback argument to any cache listeners that are invoked in the operation.
|
| LocalInvalidate(ICacheableKey, IGFSerializable) |
Locally invalidates the entry with the specified key, passing the
callback argument to any cache listeners that are invoked in the operation.
|
| LocalInvalidateRegion() |
Invalidates this region without distributing to other caches.
|
| LocalInvalidateRegion(IGFSerializable) |
Invalidates this region without distributing to other caches.
|
| LocalPut(CacheableKey, IGFSerializable) |
Puts a new value into an entry in this region with the specified key
in the local cache only.
|
| LocalPut(CacheableKey, Serializable) |
Puts a new value into an entry in this region with the specified key
in the local cache only.
|
| LocalPut(ICacheableKey, IGFSerializable) |
Puts a new value into an entry in this region with the specified key
in the local cache only.
|
| LocalPut(ICacheableKey, Serializable) |
Puts a new value into an entry in this region with the specified key
in the local cache only.
|
| LocalPut(CacheableKey, IGFSerializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified
key in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalPut(CacheableKey, Serializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified
key in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalPut(ICacheableKey, IGFSerializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified
key in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalPut(ICacheableKey, Serializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified
key in the local cache only, passing the callback argument to any
cache writers and cache listeners that are invoked in the operation.
|
| LocalRemove(CacheableKey, IGFSerializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| LocalRemove(CacheableKey, Serializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| LocalRemove(ICacheableKey, IGFSerializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| LocalRemove(ICacheableKey, Serializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| LocalRemove(CacheableKey, IGFSerializable, IGFSerializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| LocalRemove(CacheableKey, Serializable, IGFSerializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| LocalRemove(ICacheableKey, IGFSerializable, IGFSerializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| LocalRemove(ICacheableKey, Serializable, IGFSerializable) |
Removes the value with the specified key in the local cache only.
Remove removes not only the value but also the key and entry
from this region.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Put(CacheableKey, IGFSerializable) |
Puts a new value into an entry in this region with the specified key.
|
| Put(CacheableKey, Serializable) |
Puts a new value into an entry in this region with the specified key.
|
| Put(ICacheableKey, IGFSerializable) |
Puts a new value into an entry in this region with the specified key.
|
| Put(ICacheableKey, Serializable) |
Puts a new value into an entry in this region with the specified key.
|
| Put(CacheableKey, IGFSerializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified key,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| Put(CacheableKey, Serializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified key,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| Put(ICacheableKey, IGFSerializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified key,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| Put(ICacheableKey, Serializable, IGFSerializable) |
Puts a new value into an entry in this region with the specified key,
passing the callback argument to any cache writers and cache listeners
that are invoked in the operation.
|
| PutAll(CacheableHashMap) |
Puts a map of entries in this region.
|
| PutAll(CacheableHashMap, UInt32) |
Puts a map of entries in this region.
|
| Query(String) |
Executes the query on the server based on the predicate.
Valid only for a Native Client region.
|
| Query(String, UInt32) |
Executes the query on the server based on the predicate.
Valid only for a Native Client region.
|
| RegisterAllKeys() |
Register interest for all the keys of the region to get
updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
| RegisterAllKeys(Boolean) |
Register interest for all the keys of the region to get
updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
Should only be called for durable clients and with cache server version 5.5 onwards.
|
| RegisterAllKeys(Boolean, List<ICacheableKey>, Boolean) | |
| RegisterAllKeys(Boolean, List<ICacheableKey>, Boolean, Boolean) | |
| RegisterKeys(CacheableKey[]) |
Registers an array of keys for getting updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
| RegisterKeys(ICacheableKey[]) |
Registers an array of keys for getting updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
| RegisterKeys(CacheableKey[], Boolean, Boolean) |
Registers an array of keys for getting updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
Should only be called for durable clients and with cache server version 5.5 onwards.
|
| RegisterKeys(ICacheableKey[], Boolean, Boolean) |
Registers an array of keys for getting updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
Should only be called for durable clients and with cache server version 5.5 onwards.
|
| RegisterKeys(CacheableKey[], Boolean, Boolean, Boolean) |
Registers an array of keys for getting updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
Should only be called for durable clients and with cache server version 5.5 onwards.
|
| RegisterKeys(ICacheableKey[], Boolean, Boolean, Boolean) |
Registers an array of keys for getting updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
Should only be called for durable clients and with cache server version 5.5 onwards.
|
| RegisterRegex(String) |
Register interest for the keys of the region that match the
given regular expression to get updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
| RegisterRegex(String, Boolean) |
Register interest for the keys of the region that match the
given regular expression to get updates from the server.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
Should only be called for durable clients and with cache server version 5.5 onwards.
|
| RegisterRegex(String, Boolean, List<ICacheableKey>) | |
| RegisterRegex(String, Boolean, List<ICacheableKey>, Boolean) | |
| RegisterRegex(String, Boolean, List<ICacheableKey>, Boolean, Boolean) | |
| Remove(CacheableKey, IGFSerializable) |
Removes the entry with the specified key and value, passing the callback
argument to any cache writers that are invoked in the operation.
|
| Remove(CacheableKey, Serializable) |
Removes the entry with the specified key and value, passing the callback
argument to any cache writers that are invoked in the operation.
|
| Remove(ICacheableKey, IGFSerializable) |
Removes the entry with the specified key and value, passing the callback
argument to any cache writers that are invoked in the operation.
|
| Remove(ICacheableKey, Serializable) |
Removes the entry with the specified key and value, passing the callback
argument to any cache writers that are invoked in the operation.
|
| Remove(CacheableKey, IGFSerializable, IGFSerializable) | |
| Remove(CacheableKey, Serializable, IGFSerializable) | |
| Remove(ICacheableKey, IGFSerializable, IGFSerializable) | |
| Remove(ICacheableKey, Serializable, IGFSerializable) | |
| SelectValue(String) |
Executes the query on the server based on the predicate
and returns a single result value.
Valid only for a Native Client region.
|
| SelectValue(String, UInt32) |
Executes the query on the server based on the predicate
and returns a single result value.
Valid only for a Native Client region.
|
| SubRegions |
Returns the subregions of this region.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnregisterAllKeys |
Unregister interest for all the keys of the region to stop
getting updates for them.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
| UnregisterKeys(CacheableKey[]) |
Unregisters an array of keys to stop getting updates for them.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
| UnregisterKeys(ICacheableKey[]) |
Unregisters an array of keys to stop getting updates for them.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
| UnregisterRegex |
Unregister interest for the keys of the region that match the
given regular expression to stop getting updates for them.
The regular expression must have been registered previously using
a RegisterRegex call.
Valid only for a Native Client region when client notification
( [!:AttributesFactory.SetClientNotificationEnabled] ) is true.
|
Remarks
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 Region 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 [!:Region.GetSubRegion]. You can get the relative
path from the root region with [!:Region.FullPath]. The name separator
is used to concatenate all the region names together from the root, starting
with the root's subregions.
See Also