Registers an array of keys for getting updates from the server.
Valid only for a Native Client region when client notification
( SetClientNotificationEnabled(Boolean) ) is true.
Should only be called for durable clients and with cache server version 5.5 onwards.
Namespace: GemStone.GemFire.Cache
Assembly: GemStone.GemFire.Cache (in GemStone.GemFire.Cache.dll)
Version: 2.7.0.0
Syntax
| C# |
|---|
public void RegisterKeys( ICacheableKey[] keys, IGFSerializable callback, bool isDurable, bool getInitialValues ) |
| Visual Basic (Declaration) |
|---|
Public Sub RegisterKeys ( _ keys As ICacheableKey(), _ callback As IGFSerializable, _ isDurable As Boolean, _ getInitialValues As Boolean _ ) |
| Visual C++ |
|---|
public: void RegisterKeys ( array<ICacheableKey^>^ keys, IGFSerializable^ callback, bool isDurable, bool getInitialValues ) |
Parameters
- keys
- array<ICacheableKey>[]()
the array of keys
- callback
- IGFSerializable
user-defined parameter to pass to callback events triggered by this method
- isDurable
- Boolean
whether the registration should be durable
- getInitialValues
- Boolean
true to populate the cache with values of the keys that were registered on the server
Exceptions
| Exception | Condition |
|---|---|
| GemStone.GemFire.Cache..::IllegalArgumentException | If the array of keys is empty. |
| GemStone.GemFire.Cache..::IllegalStateException | If already registered interest for all keys. |
| GemStone.GemFire.Cache..::CacheServerException | If an exception is received from the Java cache server. |
| GemStone.GemFire.Cache..::NotConnectedException | if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it. |
| GemStone.GemFire.Cache..::RegionDestroyedException | If region destroy is pending. |
| GemStone.GemFire.Cache..::UnsupportedOperationException | If the region is not a Native Client region or SetClientNotificationEnabled(Boolean) is false. |
| GemStone.GemFire.Cache..::TimeoutException | if the operation timed out |
| GemStone.GemFire.Cache..::UnknownException | For other exceptions. |
See Also
Region Class
GemStone.GemFire.Cache Namespace