apache::geode::client::CqAttributesMutator Class Reference

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

#include <CqAttributesMutator.hpp>

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 CqAttributes. 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 CqAttributes.

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

aListener

the user defined CQ listener to add to the CqQuery.

Exceptions

IllegalArgumentException

if 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

aListener

the CQ listener to remove from the CqQuery.

Exceptions

IllegalArgumentException

if 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

newListeners

a possibly empty array of listeners to add to this CqQuery.

Exceptions

IllegalArgumentException

if the newListeners array has a nullptr element