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

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

Public Member Functions

void addCqListener (const std::shared_ptr< CqListener > &aListener)
 Adds a CQ listener to the end of the list of CQ listeners on this CqQuery. More...
 
 CqAttributesMutator (const std::shared_ptr< CqAttributes > &impl)
 Constructs a CqAttributesMutator with the given {}. More...
 
void removeCqListener (const std::shared_ptr< CqListener > &aListener)
 Removes given CQ listener from the list of CQ listeners on this CqQuery. More...
 
void setCqListeners (const std::vector< std::shared_ptr< CqListener >> &newListeners)
 Adds the given set CqListener 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.

Constructor & Destructor Documentation

◆ CqAttributesMutator()

apache::geode::client::CqAttributesMutator::CqAttributesMutator ( const std::shared_ptr< CqAttributes > &  impl)
explicit

Constructs a CqAttributesMutator with the given {}.

Member Function Documentation

◆ addCqListener()

void apache::geode::client::CqAttributesMutator::addCqListener ( const std::shared_ptr< CqListener > &  aListener)

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

◆ removeCqListener()

void apache::geode::client::CqAttributesMutator::removeCqListener ( const std::shared_ptr< CqListener > &  aListener)

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

◆ setCqListeners()

void apache::geode::client::CqAttributesMutator::setCqListeners ( const std::vector< std::shared_ptr< CqListener >> &  newListeners)

Adds the given set CqListener 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

Apache Geode C++ Cache API Documentation