Apache Geode Native .NET Reference  1.14.0
Apache::Geode::Client::CqQuery< TKey, TResult > Class Template Reference

Class to encapsulate a continuous query (CQ). More...

Public Member Functions

void Close ()
 stop the cq query More...
 
void Execute ()
 Executes the Cq Query on the cache server More...
 
ICqResults< TResult > ^ ExecuteWithInitialResults ()
 Executes the Cq Query on the cache server and returns the Cqresults. More...
 
ICqResults< TResult > ^ ExecuteWithInitialResults (TimeSpan timeout)
 Executes the Cq Query on the cache server with the specified timeout and returns the results. More...
 
CqAttributes< TKey, TResult > ^ GetCqAttributes ()
 Get the Attributes for this cq query. More...
 
CqAttributesMutator< TKey, TResult > ^ GetCqAttributesMutator ()
 Get the Attributes Mutator for this cq query. More...
 
Query< TResult > ^ GetQuery ()
 Get the Query for this cq query. More...
 
CqState GetState ()
 get the state of this cq query More...
 
CqStatisticsGetStatistics ()
 Get the stats for this cq query. More...
 
bool IsClosed ()
 Is this Cq in closed state? More...
 
bool IsRunning ()
 Is this Cq in running state? More...
 
bool IsStopped ()
 Is this Cq in stopped state? More...
 
void Stop ()
 stop the cq query More...
 

Properties

String^ Name [get]
 Get the name for this cq query. More...
 
String^ QueryString [get]
 Get the string for this cq query. More...
 

Detailed Description

template<class TKey, class TResult>
class Apache::Geode::Client::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.

Member Function Documentation

◆ Close()

template<class TKey , class TResult >
void Apache::Geode::Client::CqQuery< TKey, TResult >::Close ( )

stop the cq query

◆ Execute()

template<class TKey , class TResult >
void Apache::Geode::Client::CqQuery< TKey, TResult >::Execute ( )

Executes the Cq Query on the cache server

◆ ExecuteWithInitialResults() [1/2]

template<class TKey , class TResult >
ICqResults<TResult> ^ Apache::Geode::Client::CqQuery< TKey, TResult >::ExecuteWithInitialResults ( )

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

◆ ExecuteWithInitialResults() [2/2]

template<class TKey , class TResult >
ICqResults<TResult> ^ Apache::Geode::Client::CqQuery< TKey, TResult >::ExecuteWithInitialResults ( TimeSpan  timeout)

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

Parameters
timeoutThe time to wait for query response.

◆ GetCqAttributes()

template<class TKey , class TResult >
CqAttributes<TKey, TResult> ^ Apache::Geode::Client::CqQuery< TKey, TResult >::GetCqAttributes ( )

Get the Attributes for this cq query.

◆ GetCqAttributesMutator()

template<class TKey , class TResult >
CqAttributesMutator<TKey, TResult> ^ Apache::Geode::Client::CqQuery< TKey, TResult >::GetCqAttributesMutator ( )

Get the Attributes Mutator for this cq query.

◆ GetQuery()

template<class TKey , class TResult >
Query<TResult> ^ Apache::Geode::Client::CqQuery< TKey, TResult >::GetQuery ( )

Get the Query for this cq query.

◆ GetState()

template<class TKey , class TResult >
CqState Apache::Geode::Client::CqQuery< TKey, TResult >::GetState ( )

get the state of this cq query

◆ GetStatistics()

template<class TKey , class TResult >
CqStatistics ^ Apache::Geode::Client::CqQuery< TKey, TResult >::GetStatistics ( )

Get the stats for this cq query.

◆ IsClosed()

template<class TKey , class TResult >
bool Apache::Geode::Client::CqQuery< TKey, TResult >::IsClosed ( )

Is this Cq in closed state?

◆ IsRunning()

template<class TKey , class TResult >
bool Apache::Geode::Client::CqQuery< TKey, TResult >::IsRunning ( )

Is this Cq in running state?

◆ IsStopped()

template<class TKey , class TResult >
bool Apache::Geode::Client::CqQuery< TKey, TResult >::IsStopped ( )

Is this Cq in stopped state?

◆ Stop()

template<class TKey , class TResult >
void Apache::Geode::Client::CqQuery< TKey, TResult >::Stop ( )

stop the cq query

Property Documentation

◆ Name

template<class TKey , class TResult >
String^ Apache::Geode::Client::CqQuery< TKey, TResult >::Name
get

Get the name for this cq query.

◆ QueryString

template<class TKey , class TResult >
String^ Apache::Geode::Client::CqQuery< TKey, TResult >::QueryString
get

Get the string for this cq query.


Apache Geode C++ Cache .NET API Documentation