VMware GemFire Native C++ Reference  9.2.4
apache::geode::client::CqAttributesFactory Class Reference

Inherits apache::geode::client::SharedBase.

Public Member Functions

void addCqListener (const CqListenerPtr &cqListener)
 Adds a CQ listener to the end of the list of cq listeners on this factory. More...
 
 CqAttributesFactory ()
 Creates a new instance of AttributesFactory ready to create a CqAttributes with default settings. More...
 
 CqAttributesFactory (CqAttributesPtr &cqAttributes)
 Creates a new instance of CqAttributesFactory ready to create a CqAttributes with the same settings as those in the specified CqAttributes. More...
 
CqAttributesPtr create ()
 Creates a CqAttributes with the current settings. More...
 
void initCqListeners (VectorOfCqListener &cqListeners)
 Removes all Cq listeners and then adds each listener in the specified array. 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...
 

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 ( CqAttributesPtr cqAttributes)

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 CqListenerPtr 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()

CqAttributesPtr apache::geode::client::CqAttributesFactory::create ( )

Creates a CqAttributes with the current settings.

Returns
the newly created CqAttributes

◆ initCqListeners()

void apache::geode::client::CqAttributesFactory::initCqListeners ( VectorOfCqListener 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

◆ preserveSB()

void apache::geode::client::SharedBase::preserveSB ( ) const
inherited

Atomically increment reference count.

◆ refCount()

int32_t apache::geode::client::SharedBase::refCount ( )
inlineinherited
Returns
the reference count

◆ releaseSB()

void apache::geode::client::SharedBase::releaseSB ( ) const
inherited

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.


Pivotal GemFire C++ Cache API Documentation