VMware GemFire Native Client C++ API Reference

Removes all entries from this region and provides a user-defined parameter object to any CacheWriter or CacheListener invoked in the process.

See also

CacheListener::afterRegionClear

CacheWriter::beforeRegionClear

Convenience method allowing key to be a const char* This operations checks for the key in the local cache .

It is not propagated to the Geode cache server to which it is connected.

Only the client's cache is searched for the key.

It does not go to the java server to which it is connected with.

The cache of the server, to which it is connected with, is searched for the key to see if the key is present.

Exceptions

UnsupportedOperationException

if the region's scope is ScopeType::LOCAL.

Convenience method allowing key to be a const char* This operations checks for the value in the local cache .

It is not propagated to the Geode cache server to which it is connected.

This operations checks for the value in the local cache .

It is not propagated to the Geode cache server to which it is connected.

Convenience method allowing key to be a const char*.

Convenience method allowing both key and value to be a const char*.

Creates a new entry in this region with the specified key and value, providing a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener, if one is defined for this Region, invoked in the process. The new entry is propogated to the java server also to which it is connected with.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime 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	the key smart pointer for which to create the entry in this region.
value	the value for the new entry, which may be nullptr meaning the new entry starts as if it had been locally invalidated.
aCallbackArgument	a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. Should be serializable if passed to remote callback events

Exceptions

IllegalArgumentException	if key is nullptr or if the key, value, or aCallbackArgument do not meet serializability requirements
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
RegionDestroyedException	if region is no longer valid
CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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
OutOfMemoryException	if no memory for new entry
EntryExistsException	if an entry with this key already exists

Convenience method allowing value to be a const char*.

Creates a subregion with the specified attributes.

Convenience method allowing key to be a const char*.

Destroys the entry with the specified key, and provides a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener, if one is defined for this Region, invoked in the process. Destroy removes not only the value, but also the key and entry from this region.

The destroy is propogated to the Geode cache server to which it is connected with. If the destroy fails due to an exception on server throwing back CacheServerException or security exception, then the local entry is still destroyed.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the entry to destroy
aCallbackArgument	a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. If it is sent on the wire, it has to be Serializable.

Exceptions

IllegalArgumentException	if key is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
CacheServerException	If an exception is received from the Geode cache server. Only for Native Client regions.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 the region is destroyed.
EntryNotFoundException	if the entry does not exist in this region.

See also

invalidate

CacheListener::afterDestroy

CacheWriter::beforeDestroy

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

Destroy cascades to all entries and subregions. After the destroy, this region object cannot be used any more. Any attempt to use this region object will get a RegionDestroyedException exception.

The region destroy not only destroys the local region but also destroys the server region. However, if server region destroy fails throwing back CacheServerException or security exception, the local region is still destroyed.

Parameters

aCallbackArgument

a user-defined parameter to pass to callback events triggered by this call. Can be nullptr. If it is sent on the wire, it has to be Serializable.

Exceptions

CacheWriterException	if 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 geode system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 operation timed out

See also

invalidateRegion

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 to wait for the response, optional.

Exceptions

IllegalArgumentException	If timeout exceeds 2147483647ms.
QueryException	if some query error occurred at the server.
NotConnectedException	if a server connection error occurs. For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	If the message received from server could not be handled. This will be the case when the reply is not well formed. More information can be found in the log.
TimeoutException	if operation timed out
CacheClosedException	if the cache has been closed

Returns

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

Convenience method allowing key to be a const char*.

Returns the value associated with the specified key, passing the callback argument to any cache loaders 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::getLastAccessedTime, CacheStatistics::getHitCount, CacheStatistics::getMissCount, and CacheStatistics::getLastModifiedTime (if a new value is loaded) for this region and the entry.

Parameters

key	whose associated value is to be returned. The key Object must implement the equals and hashCode methods.
aCallbackArgument	an argument passed into the CacheLoader if loader is used. If it is sent on the wire, it has to be Serializable.

Exceptions

IllegalArgumentException	if key is nullptr or aCallbackArgument is not serializable and a remote CacheLoader needs to be invoked
CacheLoaderException	if CacheLoader throws an exception
CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 operation timed out
RegionDestroyedException	if the method is called on a destroyed region

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::getLastAccessedTime, CacheStatistics::getHitCount and CacheStatistics::getMissCount for this region and the entry.

Parameters

keys	the array of keys
values	Output parameter that provides the map of keys to respective values. It is ignored if nullptr, and when nullptr 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. It is ignored if nullptr.

Since

8.1

Parameters

aCallbackArgument

an argument that is passed to the callback functions. It may be nullptr. Must be serializable if this operation is distributed.

Exceptions

IllegalArgumentException	If the array of keys is empty. Other invalid case is when the values parameter is nullptr, 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 it is not connected to the cache because the client cannot establish usable connections to any of the given servers For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
TimeoutException	if operation timed out.
UnknownException	For other exceptions.

See also

get

Return the RegionAttributes for this region.

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

Exceptions

RegionDestroyedException.

Convenience method allowing key to be a const char*.

Return the meta-object RegionEntry for key.

Exceptions

IllegalArgumentException,RegionDestroyedException.

return the full path of the region as can be used to lookup the region from Cache::getRegion.

The storage is backed by the region.

Returns the list of keys on which this client is interested and will be notified of changes.

Exceptions

UnsupportedOperationException

if the region's scope is ScopeType::LOCAL.

Returns the list of regular expresssions on which this client is interested and will be notified of changes.

Exceptions

UnsupportedOperationException

if the region's scope is ScopeType::LOCAL.

Public Methods.

return single name of region. The storage is backed by the region.

Returns the parent region, or nullptr if a root region.

Exceptions

RegionDestroyedException

Returns the cache associated with this region.

Returns

the cache

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

Convenience method allowing key to be a const char*.

Invalidates the entry with the specified key, and provides a user-defined argument to the CacheListener.

Invalidate only removes the value from the entry, the key is kept intact. To completely remove the entry, destroy should be used. The invalidate is not propogated to the Geode cache server to which it is connected with.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the value to be invalidated
aCallbackArgument	a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. Should be serializable if passed to remote callback events

Exceptions

IllegalArgumentException	if key is nullptr
CacheListenerException	if CacheListener throws an exception
EntryNotFoundException	if this entry does not exist in this region locally
RegionDestroyedException	if the region is destroyed

See also

destroy

CacheListener::afterInvalidate

Invalidates this region.

The invalidation will cascade to all the subregions and cached entries. After the invalidateRegion , the region and the entries in it still exist. In order to remove all the entries and the region, destroyRegion should be used.

Parameters

aCallbackArgument

a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. If it is sent on the wire, it has to be Serializable.

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

destroyRegion

CacheListener::afterRegionInvalidate This operation is not distributed.

Return all the keys in the local process for this region.

This includes keys for which the entry is invalid.

Removes all entries from this region and provides a user-defined parameter object to any CacheWriter or CacheListener invoked in the process.

Clear will not be distributed to other caches.

See also

CacheListener::afterRegionClear

CacheWriter::beforeRegionClear

Convenience method allowing key to be a const char*.

Convenience method allowing both key and value to be a const char*.

Creates a new entry in this region with the specified key and value in the local cache only, providing a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener, if one is defined for this Region, invoked in the process.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key smart pointer for which to create the entry in this region.
value	the value for the new entry, which may be nullptr meaning the new entry starts as if it had been locally invalidated.
aCallbackArgument	a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. Should be serializable if passed to remote callback events

Exceptions

IllegalArgumentException	if key or value is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
RegionDestroyedException	if region is no longer valid
OutOfMemoryException	if no memory for new entry
EntryExistsException	if an entry with this key already exists

Convenience method allowing value to be a const char*.

Convenience method allowing key to be a const char*.

Destroys the entry with the specified key in the local cache only, and provides a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener, if one is defined for this Region, invoked in the process. Destroy removes not only the value but also the key and entry from this region.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the entry to destroy.
aCallbackArgument	the callback for user to pass in, default is nullptr.

Exceptions

IllegalArgumentException	if key is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
EntryNotFoundException	if the entry does not exist in this region locally

See also

invalidate

CacheListener::afterDestroy

CacheWriter::beforeDestroy

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

Destroy cascades to all entries and subregions. After the destroy, this region object cannot be used any more. Any attempt to use this region object will get a RegionDestroyedException exception. The region destroy is not distributed to other caches.

Parameters

aCallbackArgument

a user-defined parameter to pass to callback events triggered by this call. Can be nullptr. If it is sent on the wire, it has to be Serializable.

Exceptions

CacheWriterException	if 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

localInvalidateRegion

Convenience method allowing key to be a const char*.

Invalidates the entry with the specified key in the local cache only, and provides a user-defined argument to the CacheListener.

Invalidate only removes the value from the entry, the key is kept intact. To completely remove the entry, destroy should be used.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the value to be invalidated
aCallbackArgument	a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. Should be serializable if passed to remote callback events

Exceptions

IllegalArgumentException	if key is nullptr
CacheListenerException	if CacheListener throws an exception
EntryNotFoundException	if this entry does not exist in this region locally
RegionDestroyedException	if the region is destroyed

See also

destroy

CacheListener::afterInvalidate

Invalidates this region.

The invalidation will cascade to all the subregions and cached entries. After the invalidateRegion , the region and the entries in it still exist. In order to remove all the entries and the region, destroyRegion should be used. The region invalidate will not be distributed to other caches

Parameters

aCallbackArgument

a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. If it is sent on the wire, it has to be Serializable.

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

destroyRegion

CacheListener::afterRegionInvalidate

Convenience method allowing key to be a const char*.

Convenience method allowing both key and value to be a const char*.

Places a new value into an entry in this region with the specified key in the local cache only, providing a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener, if one is defined for this Region, invoked in the process. If there is already an entry associated with the specified key in this region, the entry's previous value is overwritten.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	a key smart pointer associated with the value to be put into this region.
value	the value to be put into the cache
aCallbackArgument	an argument that is passed to the callback functions

Exceptions

IllegalArgumentException	if key or value is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
RegionDestroyedException	if region no longer valid
OutOfMemoryException	if not enoough memory for the value

Convenience method allowing value to be a const char*.

Convenience method allowing key to be a const char*.

Convenience method allowing both key and value to be a const char*.

Removes the entry with the specified key and value in the local cache only, and provides a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener and CacheWriter, if one is defined for this Region, invoked in the process. Remove removes not only the value but also the key and entry from this region.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the entry to remove.
value	the value of the entry to remove.
aCallbackArgument	the callback for user to pass in, default is nullptr.

Exceptions

IllegalArgumentException	if key is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception

Returns

the boolean true if an entry(key, value)has been removed or false if an entry(key, value) has not been removed.

See also

destroy

CacheListener::afterDestroy

CacheWriter::beforeDestroy

Convenience method allowing value to be a const char*.

Convenience method allowing key to be a const char*.

Removes the entry with the specified key in the local cache only, and provides a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener and CacheWriter, if one is defined for this Region, invoked in the process. Remove removes not only the value but also the key and entry from this region.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the entry to remove.
aCallbackArgument	the callback for user to pass in, default is nullptr.

Exceptions

IllegalArgumentException	if key is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception

Returns

the boolean true if an entry(key, value)has been removed or false if an entry(key, value) has not been removed.

See also

destroy

CacheListener::afterDestroy

CacheWriter::beforeDestroy

Convenience method allowing key to be a const char*.

Convenience method allowing both key and value to be a const char*.

Places a new value into an entry in this region with the specified key, providing a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener, if one is defined for this Region, invoked in the process. 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.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime 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 smart pointer associated with the value to be put into this region.
value	the value to be put into the cache
aCallbackArgument	an argument that is passed to the callback function

Exceptions

IllegalArgumentException	if key or value is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
RegionDestroyedException	if region no longer valid
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 operation timed out
OutOfMemoryException	if not enoough memory for the value

Convenience method allowing value to be a const char*.

Places a set of new values in this region with the specified keys given as a map of key/value pairs.

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

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entries.

Parameters

map	A hashmap containing key-value pairs
timeout	The time to wait for the response, optional.
aCallbackArgument	an argument that is passed to the callback functions. It is ignored if nullptr. It must be serializable if this operation is distributed.

Exceptions

IllegalArgumentException

If timeout exceeds 2147483647ms.

Since

8.1

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 to wait for the query response, optional.

Exceptions

IllegalArgumentException	If timeout exceeds 2147483647ms.
QueryException	if some query error occurred at the server.
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if a server connection error occurs. For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 operation timed out
CacheClosedException	if the cache has been closed

Returns

A smart pointer to the SelectResults which can either be a ResultSet or a StructSet.

Registers to get updates for all keys from the server.

Parameters

isDurable	flag to indicate whether this is a durable registration
getInitialValues	true to populate the cache with values of all keys from the server
receiveValues	whether to act like notify-by-subscription is set

Exceptions

EntryNotFoundException	If an exception occurs while obtaining values from server after register interest is complete. The actual cause of the exception can be obtained using Exception::getCause. If an application wants to undo the registration on server, or take some other steps for the incomplete cache population then this is the exception that should be caught.
UnsupportedOperationException	If the region is not a Native Client region
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
UnknownException	For other exceptions.
TimeoutException	if operation timed out

Registers an array of keys for getting updates from the server.

Parameters

keys	the array of keys
isDurable	flag to indicate whether this is a durable registration
getInitialValues	true to populate the cache with values of the keys that were registered on the server
receiveValues	whether to act like notify-by-subscription is set

Exceptions

IllegalArgumentException	If the array of keys is empty.
IllegalStateException	If already registered interest for all keys.
EntryNotFoundException	If an exception occurs while obtaining values from server after register interest is complete. The actual cause of the exception can be obtained using Exception::getCause. If an application wants to undo the registration on server, or take some other steps for the incomplete cache population then this is the exception that should be caught.
UnsupportedOperationException	If the region is not a Native Client region
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
UnknownException	For other exceptions.
TimeoutException	if operation timed out

Registers a regular expression to match with keys to get updates from the server.

Parameters

regex	The regular expression string.
isDurable	flag to indicate whether this is a durable registration
getInitialValues	true to populate the cache with values of the keys that were registered on the server
receiveValues	whether to act like notify-by-subscription is set

Exceptions

IllegalArgumentException	If regex is empty.
IllegalStateException	If already registered interest for all keys.
EntryNotFoundException	If an exception occurs while obtaining values from server after register interest is complete. The actual cause of the exception can be obtained using Exception::getCause. If an application wants to undo the registration on server, or take some other steps for the incomplete cache population then this is the exception that should be caught.
UnsupportedOperationException	If the region is not a Native Client region
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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.
UnknownException	For other exceptions.
TimeoutException	if operation timed out

Convenience method allowing both key and value to be a const char*.

Convenience method allowing key to be a const char*.

Convenience method allowing both key and value to be a const char*.

Removes the entry with the specified key, value and provides a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener and CacheWriter, if one is defined for this Region, invoked in the process. remove removes not only the value, but also the key and entry from this region.

The remove is propogated to the Geode cache server to which it is connected with. If the destroy fails due to an exception on server throwing back CacheServerException or security exception, then the local entry is still removed.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the entry to remove
value	the value of the key to remove, it can be nullptr.
aCallbackArgument	a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. If it is sent on the wire, it has to be Serializable.

Exceptions

IllegalArgumentException	if key is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
CacheServerException	If an exception is received from the Geode cache server. Only for Native Client regions.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 the region is destroyed.

Returns

the boolean true if an entry(key, value)has been removed or false if an entry(key, value) has not been removed.

See also

destroy

CacheListener::afterDestroy

CacheWriter::beforeDestroy

Convenience method allowing value to be a const char*.

Removes all of the entries for the specified keys from this region.

The effect of this call is equivalent to that of calling destroy on this region once for each key in the specified collection. If an entry does not exist that key is skipped; EntryNotFoundException is not thrown.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entries.

Since

8.1

Parameters

keys	the keys to remove from this region.
aCallbackArgument	an argument that is passed to the callback functions. It is ignored if nullptr. It must be serializable if this operation is distributed.

Exceptions

IllegalArgumentException	If the array of keys is empty.
CacheServerException	If an exception is received from the Java cache server while processing the request.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the given servers For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
TimeoutException	if operation timed out.
UnknownException	For other exceptions.

See also

destroy

Convenience method allowing key to be a const char*.

Removes the entry with the specified key and provides a user-defined parameter object to any CacheWriter invoked in the process.

The same parameter is also passed to the CacheListener and CacheWriter, if one is defined for this Region, invoked in the process. remove removes not only the value, but also the key and entry from this region.

The remove is propogated to the Geode cache server to which it is connected with. If the destroy fails due to an exception on server throwing back CacheServerException or security exception, then the local entry is still removed.

Updates the CacheStatistics::getLastAccessedTime and CacheStatistics::getLastModifiedTime for this region and the entry.

Parameters

key	the key of the entry to remove
aCallbackArgument	a user-defined parameter to pass to callback events triggered by this method. Can be nullptr. If it is sent on the wire, it has to be Serializable.

Exceptions

IllegalArgumentException	if key is nullptr
CacheWriterException	if CacheWriter aborts the operation
CacheListenerException	if CacheListener throws an exception
CacheServerException	If an exception is received from the Geode cache server. Only for Native Client regions.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 the region is destroyed.

Returns

the boolean true if an entry(key, value)has been removed or false if an entry(key, value) has not been removed.

See also

destroy

CacheListener::afterDestroy

CacheWriter::beforeDestroy

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 to wait for the response, optional.

Exceptions

IllegalArgumentException	If timeout exceeds 2147483647ms.
QueryException	if some query error occurred at the server, or more than one result items are available.
NotConnectedException	if a server connection error occurs. For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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 operation timed out
CacheClosedException	if the cache has been closed

Returns

A smart pointer to the single ResultSet or StructSet item, or nullptr of no results are available.

Return the set of keys defined in the server process associated to 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 PEER in the distributed system. The vector v will contain only the server keys. Any prior contents in the vector will be removed.

Exceptions

CacheServerException	If an exception is received from the Geode cache server. Only for Native Client regions.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
MessageExcepton	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
UnsupportedOperationException	if the member type is not CLIENT or region is not a native client one.

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.

Populates the passed in std::vector<std::shared_ptr<Region>> with subregions of the current region.

Parameters

recursive

determines whether the method recursively fills in subregions

Exceptions

RegionDestroyedException

Registers to get updates for all keys from the server.

Exceptions

IllegalStateException	If not previously registered all keys.
UnsupportedOperationException	If the region is not a Native Client region
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
UnknownException	For other exceptions.
TimeoutException	if operation timed out

Unregisters an array of keys to stop getting updates for them.

Parameters

keys	the array of keys

Exceptions

IllegalArgumentException	If the array of keys is empty.
IllegalStateException	If no keys were previously registered.
UnsupportedOperationException	If the region is not a Native Client region
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
UnknownException	For other exceptions.
TimeoutException	if operation timed out

Unregisters a regular expression to stop getting updates for keys from the server.

Parameters

regex

The regular expression string.

Exceptions

IllegalArgumentException	If regex is empty.
IllegalStateException	If not previously registered this regular expression string.
UnsupportedOperationException	If the region is not a Native Client region
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if it is not connected to the cache because the client cannot establish usable connections to any of the servers given to it For pools configured with locators, if no locators are available, the cause of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
UnknownException	For other exceptions.
TimeoutException	if operation timed out

Return all values in the local process for this region.

No value is included for entries that are invalidated.