Pivotal GemFire Native .NET Reference  10.2.0
Apache::Geode::Client::ISubscriptionService< TKey > Interface Template Reference

This generic interface class provides all Register Interest API's for geode's generic non local region (Region<TKey, TValue>). More...

Inherited by Apache::Geode::Client::Region< TKey, TValue >.

Public Member Functions

System::Collections::Generic::ICollection< TKey > ^ GetInterestList ()
 get the interest list on this client More...
 
System::Collections::Generic::ICollection< String^> ^ GetInterestListRegex ()
 get the list of interest regular expressions on this client More...
 
void RegisterAllKeys ()
 Register interest for all the keys of the region to get updates from the server. More...
 
void RegisterAllKeys (bool isDurable)
 Register interest for all the keys of the region to get updates from the server. More...
 
void RegisterAllKeys (bool isDurable, bool getInitialValues)
 Register interest for all the keys of the region to get updates from the server. More...
 
void RegisterAllKeys (bool isDurable, bool getInitialValues, bool receiveValues)
 Register interest for all the keys of the region to get updates from the server. More...
 
void RegisterKeys (System::Collections::Generic::ICollection< TKey >^ keys)
 Registers a collection of keys for getting updates from the server. More...
 
void RegisterKeys (System::Collections::Generic::ICollection< TKey >^ keys, bool isDurable, bool getInitialValues)
 Registers a collection of keys for getting updates from the server. More...
 
void RegisterKeys (System::Collections::Generic::ICollection< TKey >^ keys, bool isDurable, bool getInitialValues, bool receiveValues)
 Registers a collection of keys for getting updates from the server. More...
 
void RegisterRegex (String^ regex)
 Register interest for the keys of the region that match the given regular expression to get updates from the server. More...
 
void 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. More...
 
void RegisterRegex (String^ regex, bool isDurable, bool getInitialValues)
 Register interest for the keys of the region that match the given regular expression to get updates from the server. More...
 
void RegisterRegex (String^ regex, bool isDurable, bool getInitialValues, bool receiveValues)
 Register interest for the keys of the region that match the given regular expression to get updates from the server. More...
 
void UnregisterAllKeys ()
 Unregister interest for all the keys of the region to stop getting updates for them. More...
 
void UnregisterKeys (System::Collections::Generic::ICollection< TKey >^ keys)
 Unregisters a collection of keys to stop getting updates for them. More...
 
void UnregisterRegex (String^ regex)
 Unregister interest for the keys of the region that match the given regular expression to stop getting updates for them. More...
 

Detailed Description

template<class TKey>
interface Apache::Geode::Client::ISubscriptionService< TKey >

This generic interface class provides all Register Interest API's for geode'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.

Member Function Documentation

◆ GetInterestList()

template<class TKey >
System::Collections::Generic::ICollection<TKey> ^ Apache::Geode::Client::ISubscriptionService< TKey >::GetInterestList ( )

get the interest list on this client

◆ GetInterestListRegex()

template<class TKey >
System::Collections::Generic::ICollection<String^> ^ Apache::Geode::Client::ISubscriptionService< TKey >::GetInterestListRegex ( )

get the list of interest regular expressions on this client

◆ RegisterAllKeys() [1/4]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterAllKeys ( )

Register interest for all the keys of the region to get updates from the server.

Exceptions
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterAllKeys() [2/4]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterAllKeys ( bool  isDurable)

Register interest for all the keys of the region to get updates from the server.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
isDurablewhether the registration should be durable
Exceptions
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterAllKeys() [3/4]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterAllKeys ( bool  isDurable,
bool  getInitialValues 
)

Register interest for all the keys of the region to get updates from the server.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
isDurablewhether the registration should be durable
getInitialValuestrue to populate the cache with values of all the keys from the server
Exceptions
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterAllKeys() [4/4]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterAllKeys ( bool  isDurable,
bool  getInitialValues,
bool  receiveValues 
)

Register interest for all the keys of the region to get updates from the server.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
isDurablewhether the registration should be durable
getInitialValuestrue to populate the cache with values of all the keys from the server
receiveValueswhether to act like notify-by-subscription is true
Exceptions
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif not connected to the Geode system because the client cannot establish usable connections to any of the servers given to it.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterKeys() [1/3]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterKeys ( System::Collections::Generic::ICollection< TKey >^  keys)

Registers a collection of keys for getting updates from the server.

Parameters
keysa collection of keys
Exceptions
IllegalArgumentExceptionIf the collection of keys is empty.
IllegalStateExceptionIf already registered interest for all keys.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterKeys() [2/3]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterKeys ( System::Collections::Generic::ICollection< TKey >^  keys,
bool  isDurable,
bool  getInitialValues 
)

Registers a collection of keys for getting updates from the server.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
keysa collection of keys
isDurablewhether the registration should be durable
getInitialValuestrue to populate the cache with values of the keys that were registered on the server
Exceptions
IllegalArgumentExceptionIf the collection of keys is empty.
IllegalStateExceptionIf already registered interest for all keys.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterKeys() [3/3]

template<class TKey >
void Apache::Geode::Client::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.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
keysa collection of keys
isDurablewhether the registration should be durable
getInitialValuestrue to populate the cache with values of the keys that were registered on the server
receiveValueswhether to act like notify-by-subscription is true
Exceptions
IllegalArgumentExceptionIf the collection of keys is empty.
IllegalStateExceptionIf already registered interest for all keys.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif not connected to the Geode system because the client cannot establish usable connections to any of the servers given to it.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterRegex() [1/4]

template<class TKey >
void Apache::Geode::Client::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.

Exceptions
IllegalArgumentExceptionIf the regular expression string is empty.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
MessageExceptionIf 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.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterRegex() [2/4]

template<class TKey >
void Apache::Geode::Client::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.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
regexthe regular expression to register
isDurablewhether the registration should be durable
Exceptions
IllegalArgumentExceptionIf the regular expression string is empty.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
MessageExceptionIf 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.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterRegex() [3/4]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterRegex ( String^  regex,
bool  isDurable,
bool  getInitialValues 
)

Register interest for the keys of the region that match the given regular expression to get updates from the server.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
regexthe regular expression to register
isDurablewhether the registration should be durable
getInitialValuestrue to populate the cache with values of the keys that were registered on the server
Exceptions
IllegalArgumentExceptionIf the regular expression string is empty.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
MessageExceptionIf 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.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ RegisterRegex() [4/4]

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::RegisterRegex ( String^  regex,
bool  isDurable,
bool  getInitialValues,
bool  receiveValues 
)

Register interest for the keys of the region that match the given regular expression to get updates from the server.

Should only be called for durable clients and with cache server version 5.5 onwards.

Parameters
regexthe regular expression to register
isDurablewhether the registration should be durable
getInitialValuestrue to populate the cache with values of the keys that were registered on the server
receiveValueswhether to act like notify-by-subscription is true
Exceptions
IllegalArgumentExceptionIf the regular expression string is empty.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif not connected to the Geode system because the client cannot establish usable connections to any of the servers given to it.
MessageExceptionIf 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.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ UnregisterAllKeys()

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::UnregisterAllKeys ( )

Unregister interest for all the keys of the region to stop getting updates for them.

Exceptions
IllegalStateExceptionIf not previously registered all keys.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ UnregisterKeys()

template<class TKey >
void Apache::Geode::Client::ISubscriptionService< TKey >::UnregisterKeys ( System::Collections::Generic::ICollection< TKey >^  keys)

Unregisters a collection of keys to stop getting updates for them.

Parameters
keysthe collection of keys
Exceptions
IllegalArgumentExceptionIf the collection of keys is empty.
IllegalStateExceptionIf no keys were previously registered.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

◆ UnregisterRegex()

template<class TKey >
void Apache::Geode::Client::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.

Exceptions
IllegalArgumentExceptionIf the regular expression string is empty.
IllegalStateExceptionIf this regular expression has not been registered by a previous call to RegisterRegex.
CacheServerExceptionIf an exception is received from the Java cache server.
NotConnectedExceptionif 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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedExceptionIf region destroy is pending.
UnsupportedOperationExceptionIf the region is not a Native Client region
TimeoutExceptionif the operation timed out
UnknownExceptionFor other exceptions.

Apache Geode C++ Cache .NET API Documentation