Pivotal GemFire Native Client Cache Reference  9.0.6
gemfire::CqEvent Class Referenceabstract

This interface provides methods to get all the information sent from the server about the CQ event. More...

Public Member Functions

virtual CqOperation::CqOperationType getBaseOperation () const =0
 Get the operation on the base region that triggered this event. More...
 
virtual CqQueryPtr getCq () const =0
 Get the CqQuery object of this event. More...
 
virtual CacheableBytesPtr getDeltaValue () const =0
 Get the delta modification. More...
 
virtual CacheableKeyPtr getKey () const =0
 Get the key relating to the event. More...
 
virtual CacheablePtr getNewValue () const =0
 Get the new value of the modification. More...
 
virtual CqOperation::CqOperationType getQueryOperation () const =0
 Get the operation on the query results. More...
 

Detailed Description

This interface provides methods to get all the information sent from the server about the CQ event.

The CqEvent is passed to the CQs CqListener methods. It can be used to retrieve such information as the region operation, CQ operation associated with the event, the new key and value from the event, and the CqQuery object associated with the event. The CqEvent is not an extension of CacheEvent.

Member Function Documentation

virtual CqOperation::CqOperationType gemfire::CqEvent::getBaseOperation ( ) const
pure virtual

Get the operation on the base region that triggered this event.

Returns
Operation operation on the base region (on which CQ is created).
virtual CqQueryPtr gemfire::CqEvent::getCq ( ) const
pure virtual

Get the CqQuery object of this event.

See also
CqQuery
Returns
CqQuery object.
virtual CacheableBytesPtr gemfire::CqEvent::getDeltaValue ( ) const
pure virtual

Get the delta modification.

If there is no delta, returns null. New value may still be available.

Returns
CacheableBytes delta value.
virtual CacheableKeyPtr gemfire::CqEvent::getKey ( ) const
pure virtual

Get the key relating to the event.

In case of REGION_CLEAR and REGION_INVALIDATE operation, the key will be NULLPTR.

Returns
Object key.
virtual CacheablePtr gemfire::CqEvent::getNewValue ( ) const
pure virtual

Get the new value of the modification.

If there is no new value returns NULLPTR, this will happen during delete operation.

Returns
Object new/modified value.
virtual CqOperation::CqOperationType gemfire::CqEvent::getQueryOperation ( ) const
pure virtual

Get the operation on the query results.

Supported operations include update, create, destroy, region clear and region invalidate.

Returns
Operation operation with respect to CQ.

GemFire C++ Cache API Documentation