GemStone::GemFire::Cache::Generic::ISubscriptionService

GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey > Interface Template Reference

Inherited by GemStone::GemFire::Cache::Generic::Region< TKey, TValue >.

Detailed Description

template<class TKey>
interface GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >

This generic interface class provides all Register Interest API's for gemfire's generic non local region (Region<TKey, TValue>). Region<TKey, TValue> class implements all methods of this interface class. LocalRegion<TKey, TValue> class does not implement this interface class.

Public Member Functions

System::Collections::Generic::ICollection
< TKey >^ 		GetInterestList ()
System::Collections::Generic::ICollection
< String^ >^ 		GetInterestListRegex ()
void RegisterAllKeys (bool isDurable, System::Collections::Generic::ICollection< TKey >^resultKeys, bool getInitialValues, bool receiveValues)
void RegisterAllKeys (bool isDurable, System::Collections::Generic::ICollection< TKey >^resultKeys, bool getInitialValues)
void RegisterAllKeys (bool isDurable)
void RegisterAllKeys ()
void RegisterKeys (System::Collections::Generic::ICollection< TKey >^keys, bool isDurable, bool getInitialValues, bool receiveValues)
void RegisterKeys (System::Collections::Generic::ICollection< TKey >^keys, bool isDurable, bool getInitialValues)
void RegisterKeys (System::Collections::Generic::ICollection< TKey >^keys)
void RegisterRegex (String^ regex, bool isDurable, System::Collections::Generic::ICollection< TKey >^resultKeys, bool getInitialValues, bool receiveValues)
void RegisterRegex (String^ regex, bool isDurable, System::Collections::Generic::ICollection< TKey >^resultKeys, bool getInitialValues)
void RegisterRegex (String^ regex, bool isDurable, System::Collections::Generic::ICollection< TKey >^resultKeys)
void RegisterRegex (String^ regex, bool isDurable)
void RegisterRegex (String^ regex)
void UnregisterAllKeys ()
void UnregisterKeys (System::Collections::Generic::ICollection< TKey >^keys)
void UnregisterRegex (String^ regex)

Member Function Documentation

template<class TKey>
System::Collections::Generic::ICollection<TKey> ^ GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::GetInterestList (  ) 

get the interest list on this client

template<class TKey>
System::Collections::Generic::ICollection<String^> ^ GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::GetInterestListRegex (  ) 

get the list of interest regular expressions on this client

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterAllKeys ( bool  isDurable,
System::Collections::Generic::ICollection< TKey >^  resultKeys,
bool  getInitialValues,
bool  receiveValues 
)

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
receiveValues whether to act like notify-by-subscription 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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterAllKeys ( bool  isDurable,
System::Collections::Generic::ICollection< TKey >^  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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterAllKeys ( bool  isDurable  ) 

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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterAllKeys (  ) 

Register interest for all the keys of the region to get updates from the server. Valid only for a Native Client region when client notification ( AttributesFactory.SetClientNotificationEnabled ) is true.

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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterKeys ( System::Collections::Generic::ICollection< TKey >^  keys,
bool  isDurable,
bool  getInitialValues,
bool  receiveValues 
)

Registers a collection 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 a collection 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
receiveValues whether to act like notify-by-subscription is true
Exceptions:
IllegalArgumentException If the collection 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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterKeys ( System::Collections::Generic::ICollection< TKey >^  keys,
bool  isDurable,
bool  getInitialValues 
)

Registers a collection 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 a collection 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 collection 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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterKeys ( System::Collections::Generic::ICollection< TKey >^  keys  ) 

Registers a collection of keys for getting updates from the server. Valid only for a Native Client region when client notification ( AttributesFactory.SetClientNotificationEnabled ) is true.

Parameters:
keys a collection of keys
Exceptions:
IllegalArgumentException If the collection 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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterRegex ( String^   regex,
bool  isDurable,
System::Collections::Generic::ICollection< TKey >^  resultKeys,
bool  getInitialValues,
bool  receiveValues 
)

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
receiveValues whether to act like notify-by-subscription 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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterRegex ( String^   regex,
bool  isDurable,
System::Collections::Generic::ICollection< TKey >^  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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterRegex ( String^   regex,
bool  isDurable,
System::Collections::Generic::ICollection< TKey >^  resultKeys 
)

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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterRegex ( String^   regex,
bool  isDurable 
)

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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::RegisterRegex ( String^   regex  ) 

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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::UnregisterKeys ( System::Collections::Generic::ICollection< TKey >^  keys  ) 

Unregisters a collection 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 collection of keys
Exceptions:
IllegalArgumentException If the collection 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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

template<class TKey>
void GemStone::GemFire::Cache::Generic::ISubscriptionService< TKey >::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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
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.

GemFire C++ Cache .NET API Documentation