gemfire::CqAttributesMutator Class Reference

Inherits gemfire::SharedBase.


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.

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.
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.
virtual void removeCqListener (const CqListenerPtr &aListener)=0
 Removes given CQ listener from the list of CQ listeners on this CqQuery.
virtual void setCqListeners (VectorOfCqListener &newListeners)=0
 Adds the given set CqListner on this CQ.


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:
aListener the user defined CQ listener to add to the CqQuery.
Exceptions:
IllegalArgumentException if aListener is NULLPTR

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.

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:
aListener the CQ listener to remove from the CqQuery.
Exceptions:
IllegalArgumentException if 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:
newListeners a possibly empty array of listeners to add to this CqQuery.
Exceptions:
IllegalArgumentException if the newListeners array has a NULLPTR element


GemFire C++ Cache API Documentation