VMware GemFire Native Client C++ API Reference

VMware VMware GemFire Native C++ Reference: apache::geode::client::CqAttributesFactory Class Reference
VMware VMware GemFire Native C++ Reference 10.4.3
Loading...
Searching...
No Matches
Public Member Functions
apache::geode::client::CqAttributesFactory Class Reference

The factory class for the CqAttributes instance. More...

#include <CqAttributesFactory.hpp>

Public Member Functions

void addCqListener (const std::shared_ptr< CqListener > &cqListener)
 Adds a CQ listener to the end of the list of cq listeners on this factory.
 
 CqAttributesFactory ()
 Creates a new instance of AttributesFactory ready to create a CqAttributes with default settings.
 
 CqAttributesFactory (const std::shared_ptr< CqAttributes > &cqAttributes)
 Creates a new instance of CqAttributesFactory ready to create a CqAttributes with the same settings as those in the specified CqAttributes.
 
std::shared_ptr< CqAttributes > create ()
 Creates a CqAttributes with the current settings.
 
void initCqListeners (const std::vector< std::shared_ptr< CqListener > > &cqListeners)
 Removes all Cq listeners and then adds each listener in the specified array.
 

Detailed Description

The factory class for the CqAttributes instance.

This provides the CqListener setter methods. This class maintains state for and creates new instances of the CqAttributes interface for new CqQuery instances. If you create a factory with the default constructor, then the factory is set up to create attributes with all default settings. You can also create a factory by providing a CqAttributes, which will set up the new factory with the settings provided in that attributes instance.

Once a CqAttributes is created, it can only be modified after it has been used to create a CqQuery.

See also
CqAttributes

Constructor & Destructor Documentation

◆ CqAttributesFactory() [1/2]

apache::geode::client::CqAttributesFactory::CqAttributesFactory ( )

Creates a new instance of AttributesFactory ready to create a CqAttributes with default settings.

◆ CqAttributesFactory() [2/2]

apache::geode::client::CqAttributesFactory::CqAttributesFactory ( const std::shared_ptr< CqAttributes > &  cqAttributes)
explicit

Creates a new instance of CqAttributesFactory ready to create a CqAttributes with the same settings as those in the specified CqAttributes.

Parameters
cqAttributesthe CqAttributes used to initialize this AttributesFactory

Member Function Documentation

◆ addCqListener()

void apache::geode::client::CqAttributesFactory::addCqListener ( const std::shared_ptr< CqListener > &  cqListener)

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

Parameters
cqListenerthe CqListener to add to the factory.
Exceptions
IllegalArgumentExceptionif cqListener is nullptr

◆ create()

std::shared_ptr< CqAttributes > apache::geode::client::CqAttributesFactory::create ( )

Creates a CqAttributes with the current settings.

Returns
the newly created CqAttributes

◆ initCqListeners()

void apache::geode::client::CqAttributesFactory::initCqListeners ( const std::vector< std::shared_ptr< CqListener > > &  cqListeners)

Removes all Cq listeners and then adds each listener in the specified array.

Parameters
cqListenersa possibly empty array of listeners to add to this factory.
Exceptions
IllegalArgumentExceptionif the cqListeners array has a nullptr element
Apache Geode C++ Cache API Documentation