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...

#include <ISubscriptionService.hpp>

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

CacheServerException	If an exception is received from the Java cache server.
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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For 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

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 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.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For 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

isDurable	whether the registration should be durable
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 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.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For 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

isDurable	whether the registration should be durable
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 Geode 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
TimeoutException	if the operation timed out
UnknownException	For 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

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 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.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For 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

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 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.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For 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

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 Geode 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
TimeoutException	if the operation timed out
UnknownException	For 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

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 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.
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
TimeoutException	if the operation timed out
UnknownException	For 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

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 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.
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
TimeoutException	if the operation timed out
UnknownException	For 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

regex	the regular expression to register
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 regular expression string is empty.
CacheServerException	If an exception is received from the Java cache server.
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, 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
TimeoutException	if the operation timed out
UnknownException	For 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

regex	the regular expression to register
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 regular expression string is empty.
CacheServerException	If an exception is received from the Java cache server.
NotConnectedException	if not connected to the Geode 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
TimeoutException	if the operation timed out
UnknownException	For 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

IllegalStateException	If not previously registered all keys.
CacheServerException	If an exception is received from the Java cache server.
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, innerException of NotConnectedException is set to NoAvailableLocatorsException.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For 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

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 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.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For 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

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 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.
RegionDestroyedException	If region destroy is pending.
UnsupportedOperationException	If the region is not a Native Client region
TimeoutException	if the operation timed out
UnknownException	For other exceptions.