Apache::Geode::Client::ICqStatusListener< TKey, TResult > Interface Template Reference

Extension of CqListener. More...

#include <ICqStatusListener.hpp>

Inherits Apache::Geode::Client::ICqListener< TKey, TResult >.

Public Member Functions
void	Close ()
	Called when the region containing this callback is destroyed, when the cache is closed.
void	Close ()
	Called when the region containing this callback is destroyed, when the cache is closed.
virtual void	OnCqConnected ()
	Called when the cq establishes a connection with a server.
virtual void	OnCqDisconnected ()
	Called when the cq loses connection with all servers.
void	OnError (CqEvent< TKey, TResult >^ ev)
	Handles the event of an entry's value being modified in a region.
void	OnError (CqEvent^ ev)
	Handles the event of an entry's value being modified in a region.
void	OnEvent (CqEvent< TKey, TResult >^ ev)
	Handles the event of a new key being added to a region.
void	OnEvent (CqEvent^ ev)
	Handles the event of a new key being added to a region.

Detailed Description

template<class TKey, class TResult>
interface Apache::Geode::Client::ICqStatusListener< TKey, TResult >

Extension of CqListener.

Adds two new methods to CqListener, one that is called when the cq is connected and one that is called when the cq is disconnected.

Member Function Documentation

Close() [1/2]

template<class TKey , class TResult >

void Apache::Geode::Client::ICqListener< TKey, TResult >::Close ( )

inherited

Called when the region containing this callback is destroyed, when the cache is closed.

Implementations should clean up any external resources, such as database connections. Any runtime exceptions this method throws will be logged.

It is possible for this method to be called multiple times on a single callback instance, so implementations must be tolerant of this.

See also

Cache.Close, Region.DestroyRegion

Close() [2/2]

template<class TKey , class TResult >

void Apache::Geode::Client::ICqListener< TKey, TResult >::Close ( )

inherited

Called when the region containing this callback is destroyed, when the cache is closed.

Implementations should clean up any external resources, such as database connections. Any runtime exceptions this method throws will be logged.

It is possible for this method to be called multiple times on a single callback instance, so implementations must be tolerant of this.

See also

Cache.Close, Region.DestroyRegion

OnCqConnected()

template<class TKey , class TResult >

virtual void Apache::Geode::Client::ICqStatusListener< TKey, TResult >::OnCqConnected ( )

virtual

Called when the cq establishes a connection with a server.

OnCqDisconnected()

template<class TKey , class TResult >

virtual void Apache::Geode::Client::ICqStatusListener< TKey, TResult >::OnCqDisconnected ( )

virtual

Called when the cq loses connection with all servers.

OnError() [1/2]

template<class TKey , class TResult >

void Apache::Geode::Client::ICqListener< TKey, TResult >::OnError ( CqEvent< TKey, TResult >^  ev )

inherited

Handles the event of an entry's value being modified in a region.

This entry previously existed in this region in the local cache, but its previous value may have been null.

Parameters

ev	EntryEvent denotes the event object associated with updating the entry.

See also

Region.Put

OnError() [2/2]

template<class TKey , class TResult >

void Apache::Geode::Client::ICqListener< TKey, TResult >::OnError ( CqEvent^  ev )

inherited

Handles the event of an entry's value being modified in a region.

This entry previously existed in this region in the local cache, but its previous value may have been null.

Parameters

ev	EntryEvent denotes the event object associated with updating the entry.

See also

Region.Put

OnEvent() [1/2]

template<class TKey , class TResult >

void Apache::Geode::Client::ICqListener< TKey, TResult >::OnEvent ( CqEvent< TKey, TResult >^  ev )

inherited

Handles the event of a new key being added to a region.

The entry did not previously exist in this region in the local cache (even with a null value).

This function does not throw any exception.

Parameters

ev	Denotes the event object associated with the entry creation.

See also

Region.Create, Region.Put, Region.Get

OnEvent() [2/2]

template<class TKey , class TResult >

void Apache::Geode::Client::ICqListener< TKey, TResult >::OnEvent ( CqEvent^  ev )

inherited

Handles the event of a new key being added to a region.

The entry did not previously exist in this region in the local cache (even with a null value).

This function does not throw any exception.

Parameters

ev	Denotes the event object associated with the entry creation.

See also

Region.Create, Region.Put, Region.Get