gemfire::CqListener Class Reference

Inherits gemfire::SharedBase.

Inherited by gemfire::CqStatusListener.


Detailed Description

Application plug-in interface for handling continuous query events after they occur.

The listener has two methods, one that is called when there is an event satisfied by the CQ and the other called when there is an error during CQ processing.

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.
virtual void onError (const CqEvent &aCqEvent)
 This method is invoked when there is an error during CQ processing.
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.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

Protected Member Functions

 CqListener ()


Constructor & Destructor Documentation

gemfire::CqListener::CqListener (  )  [protected]

constructors


Member Function Documentation

virtual void gemfire::CqListener::close (  )  [virtual]

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

virtual void gemfire::CqListener::onError ( const CqEvent aCqEvent  )  [virtual]

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.

virtual void gemfire::CqListener::onEvent ( const CqEvent aCqEvent  )  [virtual]

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.

void gemfire::SharedBase::preserveSB (  )  const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount (  )  [inline, inherited]

Returns:
the reference count

void gemfire::SharedBase::releaseSB (  )  const [inherited]

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.


GemFire C++ Cache API Documentation