GemStone::GemFire::Cache::Region Class Reference

---

Detailed Description

Encapsulates a concrete region of cached data.

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.

RegionAttributes

Public Member Functions
bool	ContainsKey (CacheableKey^ key)
bool	ContainsKey (ICacheableKey^ key)
bool	ContainsValueForKey (CacheableKey^ key)
bool	ContainsValueForKey (ICacheableKey^ key)
void	Create (CacheableKey^ key, Serializable^ value)
void	Create (ICacheableKey^ key, Serializable^ value)
void	Create (CacheableKey^ key, IGFSerializable^ value)
void	Create (ICacheableKey^ key, IGFSerializable^ value)
void	Create (CacheableKey^ key, Serializable^ value, IGFSerializable^ callbackArg)
void	Create (ICacheableKey^ key, Serializable^ value, IGFSerializable^ callbackArg)
void	Create (CacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callbackArg)
void	Create (ICacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callbackArg)
Region^	CreateSubRegion (String^ subRegionName, RegionAttributes^ attributes)
void	Destroy (CacheableKey^ key)
void	Destroy (ICacheableKey^ key)
void	Destroy (CacheableKey^ key, IGFSerializable^ cacheWriterArg)
void	Destroy (ICacheableKey^ key, IGFSerializable^ cacheWriterArg)
void	DestroyRegion ()
void	DestroyRegion (IGFSerializable^ callback)
bool	ExistsValue (String^ predicate)
bool	ExistsValue (String^ predicate, uint32_t timeout)
IGFSerializable^	Get (CacheableKey^ key)
IGFSerializable^	Get (ICacheableKey^ key)
IGFSerializable^	Get (CacheableKey^ key, IGFSerializable^ callback)
IGFSerializable^	Get (ICacheableKey^ key, IGFSerializable^ callback)
void	GetAll (array< CacheableKey^ >^keys, Dictionary< ICacheableKey^ , IGFSerializable^ >^values, Dictionary< ICacheableKey^ , Exception^ >^exceptions)
void	GetAll (array< ICacheableKey^ >^keys, Dictionary< ICacheableKey^ , IGFSerializable^ >^values, Dictionary< ICacheableKey^ , Exception^ >^exceptions)
void	GetAll (array< CacheableKey^ >^keys, Dictionary< ICacheableKey^ , IGFSerializable^ >^values, Dictionary< ICacheableKey^ , Exception^ >^exceptions, bool addToLocalCache)
void	GetAll (array< ICacheableKey^ >^keys, Dictionary< ICacheableKey^ , IGFSerializable^ >^values, Dictionary< ICacheableKey^ , Exception^ >^exceptions, bool addToLocalCache)
AttributesMutator^	GetAttributesMutator ()
array< RegionEntry^ >^	GetEntries (bool recursive)
RegionEntry^	GetEntry (CacheableKey^ key)
RegionEntry^	GetEntry (ICacheableKey^ key)
array< ICacheableKey^ >^	GetKeys ()
array< ICacheableKey^ >^	GetServerKeys ()
Region^	GetSubRegion (String^ path)
array < IGFSerializable^ >^	GetValues ()
void	Invalidate (CacheableKey^ key)
void	Invalidate (ICacheableKey^ key)
void	Invalidate (CacheableKey^ key, IGFSerializable^ callback)
void	Invalidate (ICacheableKey^ key, IGFSerializable^ callback)
void	InvalidateRegion ()
void	InvalidateRegion (IGFSerializable^ callback)
void	LocalCreate (CacheableKey^ key, Serializable^ value)
void	LocalCreate (CacheableKey^ key, IGFSerializable^ value)
void	LocalCreate (ICacheableKey^ key, Serializable^ value)
void	LocalCreate (ICacheableKey^ key, IGFSerializable^ value)
void	LocalCreate (CacheableKey^ key, Serializable^ value, IGFSerializable^ callbackArg)
void	LocalCreate (CacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callbackArg)
void	LocalCreate (ICacheableKey^ key, Serializable^ value, IGFSerializable^ callbackArg)
void	LocalCreate (ICacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callbackArg)
void	LocalDestroy (CacheableKey^ key)
void	LocalDestroy (ICacheableKey^ key)
void	LocalDestroy (CacheableKey^ key, IGFSerializable^ cacheListenerArg)
void	LocalDestroy (ICacheableKey^ key, IGFSerializable^ cacheListenerArg)
void	LocalDestroyRegion ()
void	LocalDestroyRegion (IGFSerializable^ callback)
void	LocalInvalidate (CacheableKey^ key)
void	LocalInvalidate (ICacheableKey^ key)
void	LocalInvalidate (CacheableKey^ key, IGFSerializable^ callback)
void	LocalInvalidate (ICacheableKey^ key, IGFSerializable^ callback)
void	LocalInvalidateRegion ()
void	LocalInvalidateRegion (IGFSerializable^ callback)
void	LocalPut (CacheableKey^ key, Serializable^ value)
void	LocalPut (ICacheableKey^ key, Serializable^ value)
void	LocalPut (CacheableKey^ key, IGFSerializable^ value)
void	LocalPut (ICacheableKey^ key, IGFSerializable^ value)
void	LocalPut (CacheableKey^ key, Serializable^ value, IGFSerializable^ callbackArg)
void	LocalPut (ICacheableKey^ key, Serializable^ value, IGFSerializable^ callbackArg)
void	LocalPut (CacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callbackArg)
void	LocalPut (ICacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callbackArg)
void	Put (CacheableKey^ key, Serializable^ value)
void	Put (ICacheableKey^ key, Serializable^ value)
void	Put (CacheableKey^ key, IGFSerializable^ value)
void	Put (ICacheableKey^ key, IGFSerializable^ value)
void	Put (CacheableKey^ key, Serializable^ value, IGFSerializable^ callback)
void	Put (ICacheableKey^ key, Serializable^ value, IGFSerializable^ callback)
void	Put (CacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callback)
void	Put (ICacheableKey^ key, IGFSerializable^ value, IGFSerializable^ callback)
void	PutAll (CacheableHashMap^ map)
void	PutAll (CacheableHashMap^ map, uint32_t timeout)
ISelectResults^	Query (String^ predicate)
ISelectResults^	Query (String^ predicate, uint32_t timeout)
void	RegisterAllKeys (bool isDurable, List< ICacheableKey^ >^resultKeys, bool getInitialValues)
void	RegisterAllKeys (bool isDurable)
void	RegisterAllKeys ()
void	RegisterKeys (array< CacheableKey^ >^keys, bool isDurable, bool getInitialValues)
void	RegisterKeys (array< CacheableKey^ >^keys)
void	RegisterKeys (array< ICacheableKey^ >^keys, bool isDurable, bool getInitialValues)
void	RegisterKeys (array< ICacheableKey^ >^keys)
void	RegisterRegex (String^ regex, bool isDurable, List< ICacheableKey^ >^resultKeys, bool getInitialValues)
void	RegisterRegex (String^ regex, bool isDurable, List< ICacheableKey^ >^resultKeys)
void	RegisterRegex (String^ regex, bool isDurable)
void	RegisterRegex (String^ regex)
IGFSerializable^	SelectValue (String^ predicate)
IGFSerializable^	SelectValue (String^ predicate, uint32_t timeout)
array< Region^ >^	SubRegions (bool recursive)
void	UnregisterAllKeys ()
void	UnregisterKeys (array< CacheableKey^ >^keys)
void	UnregisterKeys (array< ICacheableKey^ >^keys)
void	UnregisterRegex (String^ regex)
Properties
RegionAttributes^	Attributes [get]
Cache^	Cache [get]
String^	FullPath [get]
bool	IsDestroyed [get]
String^	Name [get]
Region^	ParentRegion [get]
uint32_t	Size [get]
CacheStatistics^	Statistics [get]

---

Member Function Documentation

bool GemStone::GemFire::Cache::Region::ContainsKey

(

CacheableKey^

key

)

True if the region contains the given key. This only searches in the local cache.

Parameters:

key

key to search for

Returns:

true if contained

bool GemStone::GemFire::Cache::Region::ContainsKey

(

ICacheableKey^

key

)

True if the region contains the given key. This only searches in the local cache.

Parameters:

key

key to search for

Returns:

true if contained

bool GemStone::GemFire::Cache::Region::ContainsValueForKey

(

CacheableKey^

key

)

True if the region contains a value for the given key. This only searches in the local cache.

Parameters:

key

key to search for

Returns:

true if value is not null

bool GemStone::GemFire::Cache::Region::ContainsValueForKey

(

ICacheableKey^

key

)

True if the region contains a value for the given key. This only searches in the local cache.

Parameters:

key

key to search for

Returns:

true if value is not null

void GemStone::GemFire::Cache::Region::Create	(	CacheableKey^	key,
		Serializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

void GemStone::GemFire::Cache::Region::Create	(	ICacheableKey^	key,
		Serializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

void GemStone::GemFire::Cache::Region::Create	(	CacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

void GemStone::GemFire::Cache::Region::Create	(	ICacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

void GemStone::GemFire::Cache::Region::Create	(	CacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callbackArg
	)

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.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.
	callbackArg	a custome parameter to pass to the cache writer or cache listener

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

void GemStone::GemFire::Cache::Region::Create	(	ICacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callbackArg
	)

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.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.
	callbackArg	a custome parameter to pass to the cache writer or cache listener

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

void GemStone::GemFire::Cache::Region::Create	(	CacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callbackArg
	)

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.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.
	callbackArg	a custome parameter to pass to the cache writer or cache listener

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

void GemStone::GemFire::Cache::Region::Create	(	ICacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callbackArg
	)

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.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

The new entry is propogated to the java server to which it is connected with.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	The key for which to create the entry in this region. The object is created before the call, and the caller should not deallocate the object.
	value	The value for the new entry, which may be null to indicate that the new entry starts as if it had been locally invalidated.
	callbackArg	a custome parameter to pass to the cache writer or cache listener

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to a GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if region has been destroyed
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the new entry
	EntryExistsException	if an entry with this key already exists

See also:

Put, Get

Region ^ GemStone::GemFire::Cache::Region::CreateSubRegion	(	String^	subRegionName,
		RegionAttributes^	attributes
	)

Creates a subregion with the given name and attributes.

Parameters:

	subRegionName	new subregion name
	attributes	subregion attributes

Returns:

new subregion

See also:

CreateServerSubRegion

void GemStone::GemFire::Cache::Region::Destroy

(

CacheableKey^

key

)

[inline]

Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.

Destroy removes not only the value, but also the key and entry from this region.

The destroy is propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

key

the key of the entry to destroy

Exceptions:

	IllegalArgumentException	if key is null
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	EntryNotFoundException	if the entry does not exist in this region locally
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

LocalDestroy, Invalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::Destroy

(

ICacheableKey^

key

)

[inline]

Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.

Destroy removes not only the value, but also the key and entry from this region.

The destroy is propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

key

the key of the entry to destroy

Exceptions:

	IllegalArgumentException	if key is null
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	EntryNotFoundException	if the entry does not exist in this region locally
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

LocalDestroy, Invalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::Destroy	(	CacheableKey^	key,
		IGFSerializable^	cacheWriterArg
	)

Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.

Destroy removes not only the value, but also the key and entry from this region.

The destroy is propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

	key	the key of the entry to destroy
	cacheWriterArg	a user-defined parameter to pass to cache writers triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	EntryNotFoundException	if the entry does not exist in this region locally
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

LocalDestroy, Invalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::Destroy	(	ICacheableKey^	key,
		IGFSerializable^	cacheWriterArg
	)

Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.

Destroy removes not only the value, but also the key and entry from this region.

The destroy is propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

	key	the key of the entry to destroy
	cacheWriterArg	a user-defined parameter to pass to cache writers triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	EntryNotFoundException	if the entry does not exist in this region locally
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

LocalDestroy, Invalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::DestroyRegion

(

)

[inline]

Destroys the whole distributed region and provides a user-defined parameter object to any ICacheWriter invoked in the process.

Destroy cascades to all entries and subregions. After the destroy, this region object can not be used any more. Any attempt to use this region object will get a RegionDestroyedException The region destroy not only destroys the local region but also destroys the server region.

Does not update any CacheStatistics.

Exceptions:

	CacheWriterException	if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed.
	CacheListenerException	if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out

See also:

InvalidateRegion

void GemStone::GemFire::Cache::Region::DestroyRegion

(

IGFSerializable^

callback

)

Destroys the whole distributed region and provides a user-defined parameter object to any ICacheWriter invoked in the process.

Destroy cascades to all entries and subregions. After the destroy, this region object can not be used any more. Any attempt to use this region object will get a RegionDestroyedException The region destroy not only destroys the local region but also destroys the server region.

Does not update any CacheStatistics.

Parameters:

callback

a user-defined parameter to pass to callback events triggered by this call

Exceptions:

	CacheWriterException	if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed.
	CacheListenerException	if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out

See also:

InvalidateRegion

bool GemStone::GemFire::Cache::Region::ExistsValue

(

String^

predicate

)

Executes the query on the server based on the predicate and returns whether any result exists. Valid only for a Native Client region.

Parameters:

predicate

The query predicate (just the WHERE clause) or the entire query to execute

Exceptions:

	IllegalArgumentException	If the predicate is empty.
	IllegalStateException	If some error occurred.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	QueryException	If some query error occurred at the server.
	TimeoutException	if the operation timed out
	CacheClosedException	if the cache has been closed

Returns:

true if the result size is non-zero, false otherwise.

bool GemStone::GemFire::Cache::Region::ExistsValue	(	String^	predicate,
		uint32_t	timeout
	)

Executes the query on the server based on the predicate and returns whether any result exists. Valid only for a Native Client region.

Parameters:

	predicate	The query predicate (just the WHERE clause) or the entire query to execute
	timeout	The time (in seconds) to wait for the query response

Exceptions:

	IllegalArgumentException	If the predicate is empty.
	IllegalStateException	If some error occurred.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	QueryException	If some query error occurred at the server.
	TimeoutException	if the operation timed out
	CacheClosedException	if the cache has been closed

Returns:

true if the result size is non-zero, false otherwise.

IGFSerializable ^ GemStone::GemFire::Cache::Region::Get

(

CacheableKey^

key

)

[inline]

Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.

If the value is not present locally then it is requested from the java server. If even that is unsuccessful then a local CacheLoader will be invoked if there is one.

The value returned by get is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods.

Updates the CacheStatistics.LastAccessedTime CacheStatistics.HitCount, CacheStatistics.MissCount, and CacheStatistics.LastModifiedTime (if a new value is loaded) for this region and the entry.

Parameters:

key

key whose associated value is to be returned -- the key object must implement the Equals and GetHashCode methods.

Returns:

value, or null if the value is not found and can't be loaded

Exceptions:

	IllegalArgumentException	if key is null
	CacheLoaderException	if CacheLoader throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

Put

IGFSerializable ^ GemStone::GemFire::Cache::Region::Get

(

ICacheableKey^

key

)

[inline]

Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.

If the value is not present locally then it is requested from the java server. If even that is unsuccessful then a local CacheLoader will be invoked if there is one.

The value returned by get is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods.

Updates the CacheStatistics.LastAccessedTime CacheStatistics.HitCount, CacheStatistics.MissCount, and CacheStatistics.LastModifiedTime (if a new value is loaded) for this region and the entry.

Parameters:

key

key whose associated value is to be returned -- the key object must implement the Equals and GetHashCode methods.

Returns:

value, or null if the value is not found and can't be loaded

Exceptions:

	IllegalArgumentException	if key is null
	CacheLoaderException	if CacheLoader throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

Put

IGFSerializable ^ GemStone::GemFire::Cache::Region::Get	(	CacheableKey^	key,
		IGFSerializable^	callback
	)

Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.

If the value is not present locally then it is requested from the java server. If even that is unsuccessful then a local CacheLoader will be invoked if there is one.

The value returned by get is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods.

Updates the CacheStatistics.LastAccessedTime CacheStatistics.HitCount, CacheStatistics.MissCount, and CacheStatistics.LastModifiedTime (if a new value is loaded) for this region and the entry.

Parameters:

	key	key whose associated value is to be returned -- the key object must implement the Equals and GetHashCode methods.
	callback	An argument passed into the CacheLoader if loader is used. Has to be Serializable (i.e. implement IGFSerializable); can be null.

Returns:

value, or null if the value is not found and can't be loaded

Exceptions:

	IllegalArgumentException	if key is null
	CacheLoaderException	if CacheLoader throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

Put

IGFSerializable ^ GemStone::GemFire::Cache::Region::Get	(	ICacheableKey^	key,
		IGFSerializable^	callback
	)

Returns the value for the given key, passing the callback argument to any cache loaders or that are invoked in the operation.

If the value is not present locally then it is requested from the java server. If even that is unsuccessful then a local CacheLoader will be invoked if there is one.

The value returned by get is not copied, so multi-threaded applications should not modify the value directly, but should use the update methods.

Updates the CacheStatistics.LastAccessedTime CacheStatistics.HitCount, CacheStatistics.MissCount, and CacheStatistics.LastModifiedTime (if a new value is loaded) for this region and the entry.

Parameters:

	key	key whose associated value is to be returned -- the key object must implement the Equals and GetHashCode methods.
	callback	An argument passed into the CacheLoader if loader is used. Has to be Serializable (i.e. implement IGFSerializable); can be null.

Returns:

value, or null if the value is not found and can't be loaded

Exceptions:

	IllegalArgumentException	if key is null
	CacheLoaderException	if CacheLoader throws an exception
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	TimeoutException	if the operation timed out
	RegionDestroyedException	if this region has been destroyed

See also:

Put

void GemStone::GemFire::Cache::Region::GetAll	(	array< CacheableKey^ >^	keys,
		Dictionary< ICacheableKey^ , IGFSerializable^ >^	values,
		Dictionary< ICacheableKey^ , Exception^ >^	exceptions
	)			[inline]

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 CacheStatistics.LastAccessedTime and CacheStatistics.HitCount and CacheStatistics.MissCount for this region and the entry.

Parameters:

	keys	the array of keys
	values	output parameter that provides the map of keys to respective values; when this is NULL then an IllegalArgumentException is thrown.
	exceptions	output parameter that provides the map of keys to any exceptions while obtaining the key; ignored if this is NULL

Exceptions:

	IllegalArgumentException	If the array of keys is null or empty, or values argument is null.
	CacheServerException	If an exception is received from the Java cache server while processing the request.
	NotConnectedException	if region is not connected to the cache because the client cannot establish usable connections to any of the given servers
	RegionDestroyedException	If region destroy is pending.
	TimeoutException	if operation timed out.
	UnknownException	For other exceptions.

See also:

Get

void GemStone::GemFire::Cache::Region::GetAll	(	array< ICacheableKey^ >^	keys,
		Dictionary< ICacheableKey^ , IGFSerializable^ >^	values,
		Dictionary< ICacheableKey^ , Exception^ >^	exceptions
	)			[inline]

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 CacheStatistics.LastAccessedTime and CacheStatistics.HitCount and CacheStatistics.MissCount for this region and the entry.

Parameters:

	keys	the array of keys
	values	output parameter that provides the map of keys to respective values; when this is NULL then an IllegalArgumentException is thrown.
	exceptions	output parameter that provides the map of keys to any exceptions while obtaining the key; ignored if this is NULL

Exceptions:

	IllegalArgumentException	If the array of keys is null or empty, or values argument is null.
	CacheServerException	If an exception is received from the Java cache server while processing the request.
	NotConnectedException	if region is not connected to the cache because the client cannot establish usable connections to any of the given servers
	RegionDestroyedException	If region destroy is pending.
	TimeoutException	if operation timed out.
	UnknownException	For other exceptions.

See also:

Get

void GemStone::GemFire::Cache::Region::GetAll	(	array< CacheableKey^ >^	keys,
		Dictionary< ICacheableKey^ , IGFSerializable^ >^	values,
		Dictionary< ICacheableKey^ , Exception^ >^	exceptions,
		bool	addToLocalCache
	)

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 CacheStatistics.LastAccessedTime and CacheStatistics.HitCount and CacheStatistics.MissCount for this region and the entry.

Parameters:

	keys	the array of keys
	values	output parameter that provides the map of keys to respective values; ignored if NULL; when this is NULL then at least the addToLocalCache parameter should be true and caching should be enabled for the region to get values into the region otherwise an IllegalArgumentException is thrown.
	exceptions	output parameter that provides the map of keys to any exceptions while obtaining the key; ignored if this is NULL
	addToLocalCache	true if the obtained values have also to be added to the local cache

Exceptions:

	IllegalArgumentException	If the array of keys is null or empty. Other invalid case is when the values parameter is NULL, and either addToLocalCache is false or caching is disabled for this region.
	CacheServerException	If an exception is received from the Java cache server while processing the request.
	NotConnectedException	if region is not connected to the cache because the client cannot establish usable connections to any of the given servers
	RegionDestroyedException	If region destroy is pending.
	TimeoutException	if operation timed out.
	UnknownException	For other exceptions.

See also:

Get

void GemStone::GemFire::Cache::Region::GetAll	(	array< ICacheableKey^ >^	keys,
		Dictionary< ICacheableKey^ , IGFSerializable^ >^	values,
		Dictionary< ICacheableKey^ , Exception^ >^	exceptions,
		bool	addToLocalCache
	)

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 CacheStatistics.LastAccessedTime and CacheStatistics.HitCount and CacheStatistics.MissCount for this region and the entry.

Parameters:

	keys	the array of keys
	values	output parameter that provides the map of keys to respective values; ignored if NULL; when this is NULL then at least the addToLocalCache parameter should be true and caching should be enabled for the region to get values into the region otherwise an IllegalArgumentException is thrown.
	exceptions	output parameter that provides the map of keys to any exceptions while obtaining the key; ignored if this is NULL
	addToLocalCache	true if the obtained values have also to be added to the local cache

Exceptions:

	IllegalArgumentException	If the array of keys is null or empty. Other invalid case is when the values parameter is NULL, and either addToLocalCache is false or caching is disabled for this region.
	CacheServerException	If an exception is received from the Java cache server while processing the request.
	NotConnectedException	if region is not connected to the cache because the client cannot establish usable connections to any of the given servers
	RegionDestroyedException	If region destroy is pending.
	TimeoutException	if operation timed out.
	UnknownException	For other exceptions.

See also:

Get

AttributesMutator ^ GemStone::GemFire::Cache::Region::GetAttributesMutator

(

)

Return a mutator object for changing a subset of the region attributes.

Returns:

attribute mutator

Exceptions:

RegionDestroyedException

if the region has been destroyed

array<RegionEntry^> ^ GemStone::GemFire::Cache::Region::GetEntries

(

bool

recursive

)

Gets the entries in this region.

Parameters:

recursive

if true, also return all nested subregion entries

Returns:

array of entries

RegionEntry ^ GemStone::GemFire::Cache::Region::GetEntry

(

CacheableKey^

key

)

Return the meta-object RegionEntry for the given key.

Parameters:

key

key to use

Returns:

region entry object

Exceptions:

	IllegalArgumentException	key is null
	RegionDestroyedException	region has been destroyed

RegionEntry ^ GemStone::GemFire::Cache::Region::GetEntry

(

ICacheableKey^

key

)

Return the meta-object RegionEntry for the given key.

Parameters:

key

key to use

Returns:

region entry object

Exceptions:

	IllegalArgumentException	key is null
	RegionDestroyedException	region has been destroyed

array<ICacheableKey^> ^ GemStone::GemFire::Cache::Region::GetKeys

(

)

Returns all the keys in the local process for this region. This includes keys for which the entry is invalid.

Returns:

array of keys

array<ICacheableKey^> ^ GemStone::GemFire::Cache::Region::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.

Exceptions:

	UnsupportedOperationException	if the member type is not Client or region is not a Native Client region.
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	TimeoutException	if there is a timeout getting the keys

Returns:

array of keys

Region ^ GemStone::GemFire::Cache::Region::GetSubRegion

(

String^

path

)

Returns the subregion identified by the path, null if no such subregion.

Parameters:

path

path

Returns:

subregion, or null if none

See also:

FullPath, SubRegions, ParentRegion

array<IGFSerializable^> ^ GemStone::GemFire::Cache::Region::GetValues

(

)

Returns all values in the local process for this region. No value is included for entries that are invalidated.

Returns:

array of values

void GemStone::GemFire::Cache::Region::Invalidate

(

CacheableKey^

key

)

[inline]

Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

The invalidate is not propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

key

key of the value to be invalidated

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

LocalInvalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::Invalidate

(

ICacheableKey^

key

)

[inline]

Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

The invalidate is not propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

key

key of the value to be invalidated

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

LocalInvalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::Invalidate	(	CacheableKey^	key,
		IGFSerializable^	callback
	)

Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

The invalidate is not propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

	key	key of the value to be invalidated
	callback	a user-defined parameter to pass to callback events triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

LocalInvalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::Invalidate	(	ICacheableKey^	key,
		IGFSerializable^	callback
	)

Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

The invalidate is not propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

Parameters:

	key	key of the value to be invalidated
	callback	a user-defined parameter to pass to callback events triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

LocalInvalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::InvalidateRegion

(

)

[inline]

Invalidates this region.

The invalidation will cascade to all the subregions and cached entries. The region and the entries in it will still exist.

This operation is not distributed for native clients

To remove all the entries and the region, use DestroyRegion.

Does not update any CacheStatistics.

Exceptions:

	CacheListenerException	if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if this region has been destroyed

See also:

LocalInvalidateRegion, DestroyRegion, ICacheListener.AfterRegionInvalidate

void GemStone::GemFire::Cache::Region::InvalidateRegion

(

IGFSerializable^

callback

)

Invalidates this region.

The invalidation will cascade to all the subregions and cached entries. The region and the entries in it will still exist.

This operation is not distributed for native clients

To remove all the entries and the region, use DestroyRegion.

Does not update any CacheStatistics.

Parameters:

callback

user-defined parameter to pass to callback events triggered by this method

Exceptions:

	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	if this region has been destroyed

See also:

LocalInvalidateRegion, DestroyRegion, ICacheListener.AfterRegionInvalidate

void GemStone::GemFire::Cache::Region::LocalCreate	(	CacheableKey^	key,
		Serializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value in the local cache only.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalCreate	(	CacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value in the local cache only.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalCreate	(	ICacheableKey^	key,
		Serializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value in the local cache only.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalCreate	(	ICacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Creates a new entry in this region with the specified key and value in the local cache only.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalCreate	(	CacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalCreate	(	CacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalCreate	(	ICacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalCreate	(	ICacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, then an EntryExistsException is thrown.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	the key object for which to create the entry in this region.
	value	the value to be created in this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	EntryExistsException	if an entry with this key already exists
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalDestroy

(

CacheableKey^

key

)

[inline]

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.

No ICacheWriter is invoked.

Does not update any CacheStatistics.

Parameters:

key

the key of the entry to destroy

Exceptions:

	IllegalArgumentException	if key is null
	IllegalStateException	if this region has mirroring enabled
	EntryNotFoundException	if the entry does not exist in this region locally

See also:

Destroy, LocalInvalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::LocalDestroy

(

ICacheableKey^

key

)

[inline]

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.

No ICacheWriter is invoked.

Does not update any CacheStatistics.

Parameters:

key

the key of the entry to destroy

Exceptions:

	IllegalArgumentException	if key is null
	IllegalStateException	if this region has mirroring enabled
	EntryNotFoundException	if the entry does not exist in this region locally

See also:

Destroy, LocalInvalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::LocalDestroy	(	CacheableKey^	key,
		IGFSerializable^	cacheListenerArg
	)

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.

No ICacheWriter is invoked.

Does not update any CacheStatistics.

Parameters:

	key	the key of the entry to destroy
	cacheListenerArg	a user-defined parameter to pass to cache listeners triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	IllegalStateException	if this region has mirroring enabled
	EntryNotFoundException	if the entry does not exist in this region locally

See also:

Destroy, LocalInvalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::LocalDestroy	(	ICacheableKey^	key,
		IGFSerializable^	cacheListenerArg
	)

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.

No ICacheWriter is invoked.

Does not update any CacheStatistics.

Parameters:

	key	the key of the entry to destroy
	cacheListenerArg	a user-defined parameter to pass to cache listeners triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	IllegalStateException	if this region has mirroring enabled
	EntryNotFoundException	if the entry does not exist in this region locally

See also:

Destroy, LocalInvalidate, ICacheListener.AfterDestroy, ICacheWriter.BeforeDestroy

void GemStone::GemFire::Cache::Region::LocalDestroyRegion

(

)

[inline]

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.

Destroy cascades to all entries and subregions. After the destroy, any attempt to use this region object will get a RegionDestroyedException.

Does not update any CacheStatistics.

Exceptions:

	CacheWriterException	if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed.
	CacheListenerException	if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated

See also:

DestroyRegion, LocalInvalidateRegion

void GemStone::GemFire::Cache::Region::LocalDestroyRegion

(

IGFSerializable^

callback

)

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.

Destroy cascades to all entries and subregions. After the destroy, any attempt to use this region object will get a RegionDestroyedException.

Does not update any CacheStatistics.

Parameters:

callback

a user-defined parameter to pass to callback events triggered by this call

Exceptions:

	CacheWriterException	if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed.
	CacheListenerException	if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated

See also:

DestroyRegion, LocalInvalidateRegion

void GemStone::GemFire::Cache::Region::LocalInvalidate

(

CacheableKey^

key

)

[inline]

Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

Does not update any CacheStatistics.

Parameters:

key

key of the value to be invalidated

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

Invalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::LocalInvalidate

(

ICacheableKey^

key

)

[inline]

Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

Does not update any CacheStatistics.

Parameters:

key

key of the value to be invalidated

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

Invalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::LocalInvalidate	(	CacheableKey^	key,
		IGFSerializable^	callback
	)

Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

Does not update any CacheStatistics.

Parameters:

	key	key of the value to be invalidated
	callback	a user-defined parameter to pass to callback events triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

Invalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::LocalInvalidate	(	ICacheableKey^	key,
		IGFSerializable^	callback
	)

Locally invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy.

Does not update any CacheStatistics.

Parameters:

	key	key of the value to be invalidated
	callback	a user-defined parameter to pass to callback events triggered by this method

Exceptions:

	IllegalArgumentException	if key is null
	EntryNotFoundException	if this entry does not exist in this region locally
	RegionDestroyedException	if the region is destroyed

See also:

Invalidate, Destroy, ICacheListener.AfterInvalidate

void GemStone::GemFire::Cache::Region::LocalInvalidateRegion

(

)

[inline]

Invalidates this region without distributing to other caches.

The invalidation will cascade to all the local subregions and cached entries. The region and the entries in it will still exist.

To remove all the entries and the region, use LocalDestroyRegion.

Does not update any CacheStatistics.

Exceptions:

	CacheListenerException	if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated
	RegionDestroyedException	if the region is no longer valid

See also:

InvalidateRegion, LocalDestroyRegion, ICacheListener.AfterRegionInvalidate

void GemStone::GemFire::Cache::Region::LocalInvalidateRegion

(

IGFSerializable^

callback

)

Invalidates this region without distributing to other caches.

The invalidation will cascade to all the local subregions and cached entries. The region and the entries in it will still exist.

To remove all the entries and the region, use LocalDestroyRegion.

Does not update any CacheStatistics.

Parameters:

callback

a user-defined parameter to pass to callback events triggered by this method

Exceptions:

	CacheListenerException	if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated
	RegionDestroyedException	if the region is no longer valid

See also:

InvalidateRegion, LocalDestroyRegion, ICacheListener.AfterRegionInvalidate

void GemStone::GemFire::Cache::Region::LocalPut	(	CacheableKey^	key,
		Serializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key in the local cache only.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalPut	(	ICacheableKey^	key,
		Serializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key in the local cache only.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalPut	(	CacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key in the local cache only.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalPut	(	ICacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key in the local cache only.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalPut	(	CacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalPut	(	ICacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalPut	(	CacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::LocalPut	(	ICacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callbackArg
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callbackArg	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	CacheableKey^	key,
		Serializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	ICacheableKey^	key,
		Serializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	CacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	ICacheableKey^	key,
		IGFSerializable^	value
	)			[inline]

Puts a new value into an entry in this region with the specified key.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	CacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callback
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callback	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	ICacheableKey^	key,
		Serializable^	value,
		IGFSerializable^	callback
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callback	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	CacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callback
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callback	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::Put	(	ICacheableKey^	key,
		IGFSerializable^	value,
		IGFSerializable^	callback
	)

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.

If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten. The new put value is propogated to the java server to which it is connected with. Put is intended for very simple caching situations. In general it is better to create a ICacheLoader object and allow the cache to manage the creation and loading of objects.

Updates the CacheStatistics.LastAccessedTime and CacheStatistics.LastModifiedTime for this region and the entry.

If remote server put fails throwing back a CacheServerException or security exception, then local put is tried to rollback. However, if the entry has overflowed/evicted/expired then the rollback is aborted since it may be due to a more recent notification or update by another thread.

Parameters:

	key	a key object associated with the value to be put into this region.
	value	the value to be put into this region
	callback	argument that is passed to the callback functions

Exceptions:

	IllegalArgumentException	if key is null
	CacheWriterException	if CacheWriter aborts the operation
	CacheListenerException	if CacheListener throws an exception
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Get, Create

void GemStone::GemFire::Cache::Region::PutAll

(

CacheableHashMap^

map

)

Puts a map of entries in this region.

If there is already an entry associated with any key in the map in this region, the entry's previous value is overwritten. The new values are propogated to the java server to which it is connected with. PutAll is intended for speed up large amount of put operation into the same region.

Parameters:

map

A hashmap contains entries, i.e. (key, value) pairs. Value should not be null in any of the enties.

Exceptions:

	NullPointerException	if any value in the map is null
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Put

void GemStone::GemFire::Cache::Region::PutAll	(	CacheableHashMap^	map,
		uint32_t	timeout
	)

Puts a map of entries in this region.

If there is already an entry associated with any key in the map in this region, the entry's previous value is overwritten. The new values are propogated to the java server to which it is connected with. PutAll is intended for speed up large amount of put operation into the same region.

Parameters:

	map	A hashmap contains entries, i.e. (key, value) pairs. Value should not be null in any of the enties.
	timeout	The time (in seconds) to wait for the PutAll response. It should be less than or equal to 2^31/1000 i.e. 2147483. Optional.

Exceptions:

	IllegalArgumentException	If timeout is more than 2^31/1000 i.e. 2147483.
	NullPointerException	if any value in the map is null
	RegionDestroyedException	if region has been destroyed
	CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	TimeoutException	if the operation timed out
	OutOfMemoryException	if there is not enough memory for the value

See also:

Put

ISelectResults ^ GemStone::GemFire::Cache::Region::Query

(

String^

predicate

)

Executes the query on the server based on the predicate. Valid only for a Native Client region.

Parameters:

predicate

The query predicate (just the WHERE clause) or the entire query to execute

Exceptions:

	IllegalArgumentException	If the predicate is empty.
	IllegalStateException	If some error occurred.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	QueryException	If some query error occurred at the server.
	TimeoutException	if the operation timed out
	CacheClosedException	if the cache has been closed

Returns:

The SelectResults which can either be a ResultSet or a StructSet.

ISelectResults ^ GemStone::GemFire::Cache::Region::Query	(	String^	predicate,
		uint32_t	timeout
	)

Executes the query on the server based on the predicate. Valid only for a Native Client region.

Parameters:

	predicate	The query predicate (just the WHERE clause) or the entire query to execute
	timeout	The time (in seconds) to wait for the query response, optional

Exceptions:

	IllegalArgumentException	If the predicate is empty.
	IllegalStateException	If some error occurred.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	QueryException	If some query error occurred at the server.
	TimeoutException	if the operation timed out
	CacheClosedException	if the cache has been closed

Returns:

The SelectResults which can either be a ResultSet or a StructSet.

void GemStone::GemFire::Cache::Region::RegisterAllKeys	(	bool	isDurable,
		List< ICacheableKey^ >^	resultKeys,
		bool	getInitialValues
	)

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.

Parameters:

	isDurable	whether the registration should be durable
	resultKeys	if non-null then all keys on the server are returned
	getInitialValues	true to populate the cache with values of all the keys from the server

Exceptions:

	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterAllKeys

(

bool

isDurable

)

[inline]

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.

Parameters:

isDurable

whether the registration should be durable

Exceptions:

	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterAllKeys

(

)

[inline]

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.

Exceptions:

	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterKeys	(	array< CacheableKey^ >^	keys,
		bool	isDurable,
		bool	getInitialValues
	)

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.

Parameters:

	keys	the array of keys
	isDurable	whether the registration should be durable
	getInitialValues	true to populate the cache with values of the keys that were registered on the server

Exceptions:

	IllegalArgumentException	If the array of keys is empty.
	IllegalStateException	If already registered interest for all keys.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterKeys

(

array< CacheableKey^ >^

keys

)

[inline]

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.

Parameters:

keys

the array of keys

Exceptions:

	IllegalArgumentException	If the array of keys is empty.
	IllegalStateException	If already registered interest for all keys.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterKeys	(	array< ICacheableKey^ >^	keys,
		bool	isDurable,
		bool	getInitialValues
	)

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.

Parameters:

	keys	the array of keys
	isDurable	whether the registration should be durable
	getInitialValues	true to populate the cache with values of the keys that were registered on the server

Exceptions:

	IllegalArgumentException	If the array of keys is empty.
	IllegalStateException	If already registered interest for all keys.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterKeys

(

array< ICacheableKey^ >^

keys

)

[inline]

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.

Parameters:

keys

the array of keys

Exceptions:

	IllegalArgumentException	If the array of keys is empty.
	IllegalStateException	If already registered interest for all keys.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterRegex	(	String^	regex,
		bool	isDurable,
		List< ICacheableKey^ >^	resultKeys,
		bool	getInitialValues
	)

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.

Parameters:

	regex	the regular expression to register
	isDurable	whether the registration should be durable
	resultKeys	if non-null then the keys that match the regular expression on the server are returned /param> Parameters: getInitialValues  true to populate the cache with values of the keys that were registered on the server Exceptions: IllegalArgumentException  If the regular expression string is empty. CacheServerException  If an exception is received from the Java cache server. NotConnectedException  if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it. MessageException  If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log. RegionDestroyedException  If region destroy is pending. UnsupportedOperationException  If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false. TimeoutException  if the operation timed out UnknownException  For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterRegex	(	String^	regex,
		bool	isDurable,
		List< ICacheableKey^ >^	resultKeys
	)			[inline]

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.

Parameters:

	regex	the regular expression to register
	isDurable	whether the registration should be durable
	resultKeys	if non-null then the keys that match the regular expression on the server are returned /param> Exceptions: IllegalArgumentException  If the regular expression string is empty. CacheServerException  If an exception is received from the Java cache server. NotConnectedException  if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it. MessageException  If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log. RegionDestroyedException  If region destroy is pending. UnsupportedOperationException  If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false. TimeoutException  if the operation timed out UnknownException  For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterRegex	(	String^	regex,
		bool	isDurable
	)			[inline]

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.

Parameters:

	regex	the regular expression to register
	isDurable	whether the registration should be durable

Exceptions:

	IllegalArgumentException	If the regular expression string is empty.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::RegisterRegex

(

String^

regex

)

[inline]

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.

Exceptions:

	IllegalArgumentException	If the regular expression string is empty.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

IGFSerializable ^ GemStone::GemFire::Cache::Region::SelectValue

(

String^

predicate

)

Executes the query on the server based on the predicate and returns a single result value. Valid only for a Native Client region.

Parameters:

predicate

The query predicate (just the WHERE clause) or the entire query to execute

Exceptions:

	IllegalArgumentException	If the predicate is empty.
	IllegalStateException	If some error occurred.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	QueryException	If some query error occurred at the server, or more than one result items are available.
	TimeoutException	if the operation timed out
	CacheClosedException	if the cache has been closed

Returns:

The single ResultSet or StructSet item, or NULL of no results are available.

IGFSerializable ^ GemStone::GemFire::Cache::Region::SelectValue	(	String^	predicate,
		uint32_t	timeout
	)

Executes the query on the server based on the predicate and returns a single result value. Valid only for a Native Client region.

Parameters:

	predicate	The query predicate (just the WHERE clause) or the entire query to execute
	timeout	The time (in seconds) to wait for the query response

Exceptions:

	IllegalArgumentException	If the predicate is empty.
	IllegalStateException	If some error occurred.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	MessageException	If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log.
	QueryException	If some query error occurred at the server, or more than one result items are available.
	TimeoutException	if the operation timed out
	CacheClosedException	if the cache has been closed

Returns:

The single ResultSet or StructSet item, or NULL of no results are available.

array<Region^> ^ GemStone::GemFire::Cache::Region::SubRegions

(

bool

recursive

)

Returns the subregions of this region.

Parameters:

recursive

if true, also return all nested subregions

Returns:

array of regions

Exceptions:

RegionDestroyedException

this region has already been destroyed

void GemStone::GemFire::Cache::Region::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.

Exceptions:

	IllegalStateException	If not previously registered all keys.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::UnregisterKeys

(

array< CacheableKey^ >^

keys

)

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.

Parameters:

keys

the array of keys

Exceptions:

	IllegalArgumentException	If the array of keys is empty.
	IllegalStateException	If no keys were previously registered.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::UnregisterKeys

(

array< ICacheableKey^ >^

keys

)

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.

Parameters:

keys

the array of keys

Exceptions:

	IllegalArgumentException	If the array of keys is empty.
	IllegalStateException	If no keys were previously registered.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

void GemStone::GemFire::Cache::Region::UnregisterRegex

(

String^

regex

)

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.

Exceptions:

	IllegalArgumentException	If the regular expression string is empty.
	IllegalStateException	If this regular expression has not been registered by a previous call to RegisterRegex.
	CacheServerException	If an exception is received from the Java cache server.
	NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
	RegionDestroyedException	If region destroy is pending.
	UnsupportedOperationException	If the region is not a Native Client region or AttributesFactory.SetClientNotificationEnabled is false.
	TimeoutException	if the operation timed out
	UnknownException	For other exceptions.

---

Property Documentation

RegionAttributes^ GemStone::GemFire::Cache::Region::Attributes [get]

Returns the attributes for this region, which can be used to create a new region with Cache.CreateRegion.

Returns:

region's attributes

Cache^ GemStone::GemFire::Cache::Region::Cache [get]

Gets the cache for this region.

Returns:

region's cache

String^ GemStone::GemFire::Cache::Region::FullPath [get]

Gets the region's full path, which can be used to get this region object with Cache.GetRegion.

Returns:

region's pathname

bool GemStone::GemFire::Cache::Region::IsDestroyed [get]

True if this region has been destroyed.

Returns:

true if destroyed

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

Gets the region name.

Returns:

region's name

Region^ GemStone::GemFire::Cache::Region::ParentRegion [get]

Gets the parent region.

Returns:

region's parent, if any, or null if this is a root region

Exceptions:

RegionDestroyedException

if the region has been destroyed

uint32_t GemStone::GemFire::Cache::Region::Size [get]

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.

Returns:

number of entries in the region

CacheStatistics^ GemStone::GemFire::Cache::Region::Statistics [get]

Returns the statistics for this region.

Returns:

the CacheStatistics for this region

Exceptions:

StatisticsDisabledException

if statistics have been disabled for this region

---