Region MembersvFabric GemFire .NET Client Documentation

The Region type exposes the following members.
Methods

  NameDescription
Public methodClear 
remove all entries in the local region
Public methodClear(IGFSerializable)
remove all entries in the local region
Public methodContainsKey(CacheableKey)
True if the region contains the given key. This only searches in the local cache.
Public methodContainsKey(ICacheableKey)
True if the region contains the given key. This only searches in the local cache.
Public methodContainsKeyOnServer
check to see if the key is present on the server
Public methodContainsValueForKey(CacheableKey)
True if the region contains a value for the given key. This only searches in the local cache.
Public methodContainsValueForKey(ICacheableKey)
True if the region contains a value for the given key. This only searches in the local cache.
Public methodCreate(CacheableKey, IGFSerializable)
Creates a new entry in this region with the specified key and value.
Public methodCreate(CacheableKey, Serializable)
Creates a new entry in this region with the specified key and value.
Public methodCreate(ICacheableKey, IGFSerializable)
Creates a new entry in this region with the specified key and value.
Public methodCreate(ICacheableKey, Serializable)
Creates a new entry in this region with the specified key and value.
Public methodCreate(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.
Public methodCreate(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.
Public methodCreate(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.
Public methodCreate(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.
Public methodCreateSubRegion
Creates a subregion with the given name and attributes.
Public methodDestroy(CacheableKey)
Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.
Public methodDestroy(ICacheableKey)
Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.
Public methodDestroy(CacheableKey, IGFSerializable)
Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.
Public methodDestroy(ICacheableKey, IGFSerializable)
Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.
Public methodDestroyRegion 
Destroys the whole distributed region and provides a user-defined parameter object to any ICacheWriter invoked in the process.
Public methodDestroyRegion(IGFSerializable)
Destroys the whole distributed region and provides a user-defined parameter object to any ICacheWriter invoked in the process.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExistsValue(String)
Executes the query on the server based on the predicate and returns whether any result exists. Valid only for a Native Client region.
Public methodExistsValue(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.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGet(CacheableKey)
Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.
Public methodGet(ICacheableKey)
Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.
Public methodGet(CacheableKey, IGFSerializable)
Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.
Public methodGet(ICacheableKey, IGFSerializable)
Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.
Public methodGetAll( CacheableKey , Dictionary ICacheableKey, IGFSerializable , Dictionary ICacheableKey, Exception )
Gets values for an array of keys from the local cache or server. If value for a key is not present locally then it is requested from the java server. The value returned is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods. Updates the LastAccessedTime and [!:CacheStatistics.HitCount] and [!:CacheStatistics.MissCount] for this region and the entry.
Public methodGetAll( ICacheableKey , Dictionary ICacheableKey, IGFSerializable , Dictionary ICacheableKey, Exception )
Gets values for an array of keys from the local cache or server. If value for a key is not present locally then it is requested from the java server. The value returned is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods. Updates the LastAccessedTime and [!:CacheStatistics.HitCount] and [!:CacheStatistics.MissCount] for this region and the entry.
Public methodGetAll( CacheableKey , Dictionary ICacheableKey, IGFSerializable , Dictionary ICacheableKey, Exception , Boolean)
Gets values for an array of keys from the local cache or server. If value for a key is not present locally then it is requested from the java server. The value returned is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods. Updates the LastAccessedTime and [!:CacheStatistics.HitCount] and [!:CacheStatistics.MissCount] for this region and the entry.
Public methodGetAll( ICacheableKey , Dictionary ICacheableKey, IGFSerializable , Dictionary ICacheableKey, Exception , Boolean)
Gets values for an array of keys from the local cache or server. If value for a key is not present locally then it is requested from the java server. The value returned is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods. Updates the LastAccessedTime and [!:CacheStatistics.HitCount] and [!:CacheStatistics.MissCount] for this region and the entry.
Public methodGetAttributesMutator
Return a mutator object for changing a subset of the region attributes.
Public methodGetEntries
Gets the entries in this region.
Public methodGetEntry(CacheableKey)
Return the meta-object RegionEntry for the given key.
Public methodGetEntry(ICacheableKey)
Return the meta-object RegionEntry for the given key.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetInterestList
get the interest list on this client
Public methodGetInterestListRegex
get the list of interest regular expressions on this client
Public methodGetKeys
Returns all the keys in the local process for this region. This includes keys for which the entry is invalid.
Public methodGetServerKeys
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.
Public methodGetSubRegion
Returns the subregion identified by the path, null if no such subregion.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValues
Returns all values in the local process for this region. No value is included for entries that are invalidated.
Public methodInvalidate(CacheableKey)
Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodInvalidate(ICacheableKey)
Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodInvalidate(CacheableKey, IGFSerializable)
Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodInvalidate(ICacheableKey, IGFSerializable)
Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodInvalidateRegion 
Invalidates this region.
Public methodInvalidateRegion(IGFSerializable)
Invalidates this region.
Public methodLocalClear 
remove all entries in the local region
Public methodLocalClear(IGFSerializable)
remove all entries in the local region
Public methodLocalCreate(CacheableKey, IGFSerializable)
Creates a new entry in this region with the specified key and value in the local cache only.
Public methodLocalCreate(CacheableKey, Serializable)
Creates a new entry in this region with the specified key and value in the local cache only.
Public methodLocalCreate(ICacheableKey, IGFSerializable)
Creates a new entry in this region with the specified key and value in the local cache only.
Public methodLocalCreate(ICacheableKey, Serializable)
Creates a new entry in this region with the specified key and value in the local cache only.
Public methodLocalCreate(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.
Public methodLocalCreate(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.
Public methodLocalCreate(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.
Public methodLocalCreate(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.
Public methodLocalDestroy(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.
Public methodLocalDestroy(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.
Public methodLocalDestroy(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.
Public methodLocalDestroy(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.
Public methodLocalDestroyRegion 
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.
Public methodLocalDestroyRegion(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.
Public methodLocalInvalidate(CacheableKey)
Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodLocalInvalidate(ICacheableKey)
Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodLocalInvalidate(CacheableKey, IGFSerializable)
Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodLocalInvalidate(ICacheableKey, IGFSerializable)
Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.
Public methodLocalInvalidateRegion 
Invalidates this region without distributing to other caches.
Public methodLocalInvalidateRegion(IGFSerializable)
Invalidates this region without distributing to other caches.
Public methodLocalPut(CacheableKey, IGFSerializable)
Puts a new value into an entry in this region with the specified key in the local cache only.
Public methodLocalPut(CacheableKey, Serializable)
Puts a new value into an entry in this region with the specified key in the local cache only.
Public methodLocalPut(ICacheableKey, IGFSerializable)
Puts a new value into an entry in this region with the specified key in the local cache only.
Public methodLocalPut(ICacheableKey, Serializable)
Puts a new value into an entry in this region with the specified key in the local cache only.
Public methodLocalPut(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.
Public methodLocalPut(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.
Public methodLocalPut(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.
Public methodLocalPut(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.
Public methodLocalRemove(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.
Public methodLocalRemove(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.
Public methodLocalRemove(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.
Public methodLocalRemove(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.
Public methodLocalRemove(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.
Public methodLocalRemove(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.
Public methodLocalRemove(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.
Public methodLocalRemove(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.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPut(CacheableKey, IGFSerializable)
Puts a new value into an entry in this region with the specified key.
Public methodPut(CacheableKey, Serializable)
Puts a new value into an entry in this region with the specified key.
Public methodPut(ICacheableKey, IGFSerializable)
Puts a new value into an entry in this region with the specified key.
Public methodPut(ICacheableKey, Serializable)
Puts a new value into an entry in this region with the specified key.
Public methodPut(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.
Public methodPut(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.
Public methodPut(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.
Public methodPut(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.
Public methodPutAll(CacheableHashMap)
Puts a map of entries in this region.
Public methodPutAll(CacheableHashMap, UInt32)
Puts a map of entries in this region.
Public methodQuery(String)
Executes the query on the server based on the predicate. Valid only for a Native Client region.
Public methodQuery(String, UInt32)
Executes the query on the server based on the predicate. Valid only for a Native Client region.
Public methodRegisterAllKeys 
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 ( SetClientNotificationEnabled(Boolean) ) is true.
Public methodRegisterAllKeys(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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterAllKeys(Boolean, List ICacheableKey , 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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterAllKeys(Boolean, List ICacheableKey , Boolean, 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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterKeys( CacheableKey )
Registers an array of keys for getting updates from the server. Valid only for a Native Client region when client notification ( SetClientNotificationEnabled(Boolean) ) is true.
Public methodRegisterKeys( ICacheableKey )
Registers an array of keys for getting updates from the server. Valid only for a Native Client region when client notification ( SetClientNotificationEnabled(Boolean) ) is true.
Public methodRegisterKeys( CacheableKey , Boolean, Boolean)
Registers an array of keys for getting updates from the server. Valid only for a Native Client region when client notification ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterKeys( ICacheableKey , Boolean, Boolean)
Registers an array of keys for getting updates from the server. Valid only for a Native Client region when client notification ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterKeys( 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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterKeys( 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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterRegex(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 ( SetClientNotificationEnabled(Boolean) ) is true.
Public methodRegisterRegex(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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterRegex(String, Boolean, List ICacheableKey )
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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterRegex(String, Boolean, List ICacheableKey , 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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRegisterRegex(String, Boolean, List ICacheableKey , Boolean, 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 ( SetClientNotificationEnabled(Boolean) ) is true. Should only be called for durable clients and with cache server version 5.5 onwards.
Public methodRemove(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.
Public methodRemove(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.
Public methodRemove(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.
Public methodRemove(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.
Public methodRemove(CacheableKey, IGFSerializable, IGFSerializable)
Public methodRemove(CacheableKey, Serializable, IGFSerializable)
Public methodRemove(ICacheableKey, IGFSerializable, IGFSerializable)
Public methodRemove(ICacheableKey, Serializable, IGFSerializable)
Public methodSelectValue(String)
Executes the query on the server based on the predicate and returns a single result value. Valid only for a Native Client region.
Public methodSelectValue(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.
Public methodSubRegions
Returns the subregions of this region.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUnregisterAllKeys
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 ( SetClientNotificationEnabled(Boolean) ) is true.
Public methodUnregisterKeys( CacheableKey )
Unregisters an array of keys to stop getting updates for them. Valid only for a Native Client region when client notification ( SetClientNotificationEnabled(Boolean) ) is true.
Public methodUnregisterKeys( ICacheableKey )
Unregisters an array of keys to stop getting updates for them. Valid only for a Native Client region when client notification ( SetClientNotificationEnabled(Boolean) ) is true.
Public methodUnregisterRegex
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 ( SetClientNotificationEnabled(Boolean) ) is true.
Back to Top
Properties

  NameDescription
Public propertyAttributes
Returns the attributes for this region, which can be used to create a new region with [!:Cache.CreateRegion].
Public propertyCache
Gets the cache for this region.
Public propertyFullPath
Gets the region's full path, which can be used to get this region object with GetRegion(String).
Public propertyIsDestroyed
True if this region has been destroyed.
Public propertyName
Gets the region name.
Public propertyParentRegion
Gets the parent region.
Public propertyRegionService
Gets the RegionService for this region.
Public propertySize
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.
Public propertyStatistics
Returns the statistics for this region.
Back to Top
See Also