Apache Geode Native C++ Reference  1.14.0
apache::geode::client::CqStatusListener Class Reference

Extension of CqListener. More...

Inherits apache::geode::client::CqListener.

Public Member Functions

virtual void close ()
 Called when the region containing this callback is closed or destroyed, when the cache is closed, or when a callback is removed from a region using an AttributesMutator. More...
 
virtual void onCqConnected ()
 Called when the cq establishes a connection with a server. More...
 
virtual void onCqDisconnected ()
 Called when the cq loses connection with all servers. More...
 
virtual void onError (const CqEvent &aCqEvent)
 This method is invoked when there is an error during CQ processing. More...
 
virtual void onEvent (const CqEvent &aCqEvent)
 This method is invoked when an event is occurred on the region that satisfied the query condition of this CQ. More...
 

Detailed Description

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

Since
7.0

Member Function Documentation

◆ close()

virtual void apache::geode::client::CqListener::close ( )
virtualinherited

Called when the region containing this callback is closed or destroyed, when the cache is closed, or when a callback is removed from a region using an AttributesMutator.

Implementations should cleanup 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::close
Region::localDestroyRegion()
Region::destroyRegion()
AttributesMutator

◆ onCqConnected()

virtual void apache::geode::client::CqStatusListener::onCqConnected ( )
virtual

Called when the cq establishes a connection with a server.

◆ onCqDisconnected()

virtual void apache::geode::client::CqStatusListener::onCqDisconnected ( )
virtual

Called when the cq loses connection with all servers.

◆ onError()

virtual void apache::geode::client::CqListener::onError ( const CqEvent aCqEvent)
virtualinherited

This method is invoked when there is an error during CQ processing.

The error can appear while applying query condition on the event. e.g if the event doesn't has attributes as specified in the CQ query. This event does contain an error. The newValue may or may not be available, and will be nullptr if not available.

◆ onEvent()

virtual void apache::geode::client::CqListener::onEvent ( const CqEvent aCqEvent)
virtualinherited

This method is invoked when an event is occurred on the region that satisfied the query condition of this CQ.

This event does not contain an error.


Apache Geode C++ Cache API Documentation