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

This interface is used to modify the listeners that are associated with a CQ. More...

Inherits gemfire::SharedBase.

Public Member Functions

virtual void addCqListener (const CqListenerPtr &aListener)=0
 Adds a CQ listener to the end of the list of CQ listeners on this CqQuery. More...
 
void preserveSB () const
 Atomically increment reference count. More...
 
int32_t refCount ()
 
void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. More...
 
virtual void removeCqListener (const CqListenerPtr &aListener)=0
 Removes given CQ listener from the list of CQ listeners on this CqQuery. More...
 
virtual void setCqListeners (VectorOfCqListener &newListeners)=0
 Adds the given set CqListner on this CQ. More...
 

Detailed Description

This interface is used to modify the listeners that are associated with a CQ.

Each CqQuery has an CqAttributesMutator interface which supports modification of certain CQ attributes after the CQ has been created.

Member Function Documentation

virtual void gemfire::CqAttributesMutator::addCqListener ( const CqListenerPtr aListener)
pure virtual

Adds a CQ listener to the end of the list of CQ listeners on this CqQuery.

Parameters
aListenerthe user defined CQ listener to add to the CqQuery.
Exceptions
IllegalArgumentExceptionif aListener is NULLPTR
void gemfire::SharedBase::preserveSB ( ) const
inherited

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount ( )
inlineinherited
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.

virtual void gemfire::CqAttributesMutator::removeCqListener ( const CqListenerPtr aListener)
pure virtual

Removes given CQ listener from the list of CQ listeners on this CqQuery.

Does nothing if the specified listener has not been added. If the specified listener has been added then will be called on it; otherwise does nothing.

Parameters
aListenerthe CQ listener to remove from the CqQuery.
Exceptions
IllegalArgumentExceptionif aListener is NULLPTR
virtual void gemfire::CqAttributesMutator::setCqListeners ( VectorOfCqListener newListeners)
pure virtual

Adds the given set CqListner on this CQ.

If the CQ already has CqListeners, this removes those old CQs and initializes with the newListeners.

Parameters
newListenersa possibly empty array of listeners to add to this CqQuery.
Exceptions
IllegalArgumentExceptionif the newListeners array has a NULLPTR element

GemFire C++ Cache API Documentation