This generic interface class provides all Register Interest API's for GemFire's generic non local region IRegion<TKey, TValue>. More...

Inherited by SubscriptionService< TKey >.

Public Member Functions
void	RegisterKeys (IReadOnlyCollection< TKey > keys)
	Registers a collection of keys for getting updates from the server. More...

void	RegisterKeys (IReadOnlyCollection< TKey > keys, bool isDurable)
	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. More...

void	UnregisterKeys (IReadOnlyCollection< TKey > keys)
	Unregisters a collection of keys to stop getting updates for them. 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. Should only be called for durable clients and with cache server version 5.5 onwards. More...

IReadOnlyCollection< TKey >	GetInterestList ()
	get the interest list on this client More...

IReadOnlyCollection< string >	GetInterestListRegex ()
	get the list of interest regular expressions on this client More...

void	UnregisterAllKeys ()
	Unregister interest for all the keys of the region to stop getting updates for them. 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. Should only be called for durable clients and with cache server version 5.5 onwards. 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. The regular expression must have been registered previously using a `RegisterRegex` call. More...

Detailed Description

This generic interface class provides all Register Interest API's for GemFire's generic non local region IRegion<TKey, TValue>.

Member Function Documentation

◆ GetInterestList()

IReadOnlyCollection<TKey> ISubscriptionService< TKey >.GetInterestList ( )

get the interest list on this client

◆ GetInterestListRegex()

IReadOnlyCollection<string> ISubscriptionService< TKey >.GetInterestListRegex ( )

get the list of interest regular expressions on this client

◆ RegisterAllKeys() [1/2]

void ISubscriptionService< TKey >.RegisterAllKeys ( )

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

Exceptions

GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
TimeoutException	if the operation timed out

◆ RegisterAllKeys() [2/2]

void 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

GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
GemFireInvalidOperationException	If region destroy is pending. This is maps to org.apache.geode.cache.RegionDestroyedException
TimeoutException	if the operation timed out

◆ RegisterKeys() [1/2]

void ISubscriptionService< TKey >.RegisterKeys ( IReadOnlyCollection< TKey > keys )

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

Parameters

keys	a collection of keys

Exceptions

GemFireIllegalArgumentException	If the collection of keys is empty.
ArgumentException	If already registered interest for all keys.
GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.

◆ RegisterKeys() [2/2]

void ISubscriptionService< TKey >.RegisterKeys	(	IReadOnlyCollection< TKey >	keys,
		bool	isDurable
	)

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

Exceptions

GemFireIllegalArgumentException	If the collection of keys is empty.
NullReferenceException	If the collection of keys is null.
ArgumentException	If already registered interest for all keys.
GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
TimeoutException	if the operation timed out

◆ RegisterRegex() [1/2]

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

Parameters

regex the regular expression to register

Exceptions

GemFireIllegalArgumentException	If the regular expression string is empty.
ArgumentNullException	If the regular expression string is null.
GemFireServerException	If an exception is received from the Java cache server.
GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
GemFireResponseException	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.
GemFireInvalidOperationException	If region destroy is pending. This is maps to org.apache.geode.cache.RegionDestroyedException
TimeoutException	if the operation timed out

◆ RegisterRegex() [2/2]

void 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

GemFireIllegalArgumentException	If the regular expression string is empty.
ArgumentNullException	If the regular expression string is null.
GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
GemFireResponseException	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.
GemFireInvalidOperationException	If region destroy is pending. This is maps to org.apache.geode.cache.RegionDestroyedException
TimeoutException	if the operation timed out

◆ UnregisterAllKeys()

void ISubscriptionService< TKey >.UnregisterAllKeys ( )

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

Exceptions

GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
GemFireInvalidOperationException	If region destroy is pending. This is maps to org.apache.geode.cache.RegionDestroyedException
TimeoutException	if the operation timed out

◆ UnregisterKeys()

void ISubscriptionService< TKey >.UnregisterKeys ( IReadOnlyCollection< TKey > keys )

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

Parameters

keys	the collection of keys

Exceptions

ArgumentOutOfRangeException	If the collection of keys is empty.
GemFireIllegalArgumentException	If the regular expression string is empty.
ArgumentNullException	If the regular expression string is null.
GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
TimeoutException	if the operation timed out

◆ UnregisterRegex()

void 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

ArgumentNullException	If the regular expression string is null.
GemFireIllegalArgumentException	If the regular expression string is empty.
GemFireServerException	If an exception is received from the Java cache server.
DotNetty.Transport.Channels.ConnectException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
GemFireInvalidOperationException	If region destroy is pending. This is maps to org.apache.geode.cache.RegionDestroyedException
TimeoutException	if the operation timed out

The documentation for this interface was generated from the following file:

gemfire.client/Interfaces/ISubscriptionService.cs

VMware Tanzu GemFire .NET Client API Reference

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetInterestList()

◆ GetInterestListRegex()

◆ RegisterAllKeys() [1/2]

◆ RegisterAllKeys() [2/2]

◆ RegisterKeys() [1/2]

◆ RegisterKeys() [2/2]

◆ RegisterRegex() [1/2]

◆ RegisterRegex() [2/2]

◆ UnregisterAllKeys()

◆ UnregisterKeys()

◆ UnregisterRegex()