GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult > Class Template Reference

Inherits GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::CqQuery >.


Detailed Description

template<class TKey, class TResult>
class GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >

Class to encapsulate a continuous query (CQ).

A CqQuery is obtained from a QueryService which in turn is obtained from the Cache. This can be executed to return SelectResults which can be either a ResultSet or a StructSet, or it can be just registered on the java server without returning results immediately rather only the incremental results.

This class is intentionally not thread-safe. So multiple threads should not operate on the same CqQuery object concurrently rather should have their own CqQuery objects.

Public Member Functions

void Close ()
void Execute ()
ICqResults< TResult >^ ExecuteWithInitialResults (uint32_t timeout)
ICqResults< TResult >^ ExecuteWithInitialResults ()
CqAttributes< TKey,
TResult >^ 
GetCqAttributes ()
CqAttributesMutator
< TKey, TResult >^ 
GetCqAttributesMutator ()
Query< TResult >^ GetQuery ()
CqStateType GetState ()
CqStatisticsGetStatistics ()
bool IsClosed ()
bool IsRunning ()
bool IsStopped ()
void Stop ()

Protected Member Functions

void _SetNativePtr (gemfire::CqQuery *nativeptr)
void AssignPtr (gemfire::CqQuery *nativeptr)
void InternalCleanup ()
void SetPtr (gemfire::CqQuery *nativeptr)

Properties

String^  Name [get]
String^  QueryString [get]


Member Function Documentation

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::CqQuery >::_SetNativePtr ( gemfire::CqQuery *  nativeptr  )  [inline, protected, inherited]

Set the native pointer to the new object without doing a preserveSB(). DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::CqQuery >::AssignPtr ( gemfire::CqQuery *  nativeptr  )  [inline, protected, inherited]

Used to assign the native pointer to a new object.

Note the order of preserveSB() and releaseSB(). This handles the corner case when m_nativeptr is same as nativeptr.

template<class TKey, class TResult>
void GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::Close (  ) 

stop the cq query

template<class TKey, class TResult>
void GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::Execute (  ) 

Executes the Cq Query on the cache server

template<class TKey, class TResult>
ICqResults<TResult> ^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::ExecuteWithInitialResults ( uint32_t  timeout  ) 

Executes the Cq Query on the cache server with the specified timeout and returns the results.

Parameters:
timeout The time (in seconds) to wait for query response. This should be less than or equal to 2^31/1000 i.e. 2147483.
Exceptions:
IllegalArgumentException if timeout parameter is greater than 2^31/1000.

template<class TKey, class TResult>
ICqResults<TResult> ^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::ExecuteWithInitialResults (  ) 

Executes the Cq Query on the cache server and returns the Cqresults.

template<class TKey, class TResult>
CqAttributes<TKey, TResult> ^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::GetCqAttributes (  ) 

Get the Attributes for this cq query.

template<class TKey, class TResult>
CqAttributesMutator<TKey, TResult> ^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::GetCqAttributesMutator (  ) 

Get the Attributes Mutator for this cq query.

template<class TKey, class TResult>
Query<TResult> ^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::GetQuery (  ) 

Get the Query for this cq query.

template<class TKey, class TResult>
CqStateType GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::GetState (  ) 

get the state of this cq query

template<class TKey, class TResult>
CqStatistics ^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::GetStatistics (  ) 

Get the stats for this cq query.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::CqQuery >::InternalCleanup (  )  [inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

template<class TKey, class TResult>
bool GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::IsClosed (  ) 

Is this Cq in closed state?

template<class TKey, class TResult>
bool GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::IsRunning (  ) 

Is this Cq in running state?

template<class TKey, class TResult>
bool GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::IsStopped (  ) 

Is this Cq in stopped state?

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::CqQuery >::SetPtr ( gemfire::CqQuery *  nativeptr  )  [inline, protected, inherited]

Used to set the native pointer to a new object. This should only be used when you know that the underlying object is NULL.

template<class TKey, class TResult>
void GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::Stop (  ) 

stop the cq query


Property Documentation

template<class TKey, class TResult>
String^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::Name [get]

Get the name for this cq query.

template<class TKey, class TResult>
String^ GemStone::GemFire::Cache::Generic::CqQuery< TKey, TResult >::QueryString [get]

Get the string for this cq query.


GemFire C++ Cache .NET API Documentation