gemfire::CqAttributesFactory Class Reference

Inherits gemfire::SharedBase.


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

Public Member Functions

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

Constructor & Destructor Documentation

gemfire::CqAttributesFactory::CqAttributesFactory (  ) 

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

gemfire::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:
cqAttributes the CqAttributes used to initialize this AttributesFactory


Member Function Documentation

void gemfire::CqAttributesFactory::addCqListener ( const CqListenerPtr cqListener  ) 

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

Parameters:
cqListener the CqListener to add to the factory.
Exceptions:
IllegalArgumentException if cqListener is NULLPTR

CqAttributesPtr gemfire::CqAttributesFactory::create (  ) 

Creates a CqAttributes with the current settings.

Returns:
the newly created CqAttributes

void gemfire::CqAttributesFactory::initCqListeners ( VectorOfCqListener cqListeners  ) 

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

Parameters:
cqListeners a possibly empty array of listeners to add to this factory.
Exceptions:
IllegalArgumentException if the cqListeners array has a NULLPTR element

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.


GemFire C++ Cache API Documentation