gemfire::SelectResultsIterator Class Reference

Inherits gemfire::SharedBase.


Detailed Description

A SelectResultsIterator is obtained from a ResultSet or StructSet and is used to iterate over the items available in them.

Public Member Functions

const SerializablePtr current () const
 Get the current item pointed to by the SelectResultsIterator.
bool hasNext () const
 Check whether the SelectResultsIterator has another item to get.
bool moveNext ()
 Move the iterator to point to the next item to get.
const SerializablePtr next ()
 Get the next item from the SelectResultsIterator.
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.
void reset ()
 Reset the SelectResultsIterator to point to the start of the items.

Member Function Documentation

const SerializablePtr gemfire::SelectResultsIterator::current (  )  const

Get the current item pointed to by the SelectResultsIterator.

Returns:
A smart pointer to the current item pointed to by the SelectResultsIterator.

bool gemfire::SelectResultsIterator::hasNext (  )  const

Check whether the SelectResultsIterator has another item to get.

Returns:
true if another item is available otherwise false.

bool gemfire::SelectResultsIterator::moveNext (  ) 

Move the iterator to point to the next item to get.

Returns:
true if another item was available to move to otherwise false.

const SerializablePtr gemfire::SelectResultsIterator::next (  ) 

Get the next item from the SelectResultsIterator.

Returns:
a smart pointer to the next item from the iterator or NULLPTR if no further items are available.

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.

void gemfire::SelectResultsIterator::reset (  ) 

Reset the SelectResultsIterator to point to the start of the items.


GemFire C++ Cache API Documentation