VMware Tanzu GemFire .NET Client API Reference

VMware Tanzu GemFire .NET Client: ICqQuery< TKey, TResult > Interface Template Reference
VMware Tanzu GemFire .NET Client
ICqQuery< TKey, TResult > Interface Template Reference

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

Public Member Functions

void Execute (bool reExecute=false)
 Executes the Cq Query on the cache server More...
 
IReadOnlyCollection< KeyValuePair< TKey, TResult > > ExecuteWithInitialResults ()
 Executes the Cq Query on the cache server and returns the Cqresults. More...
 
void Stop ()
 stop the cq query More...
 
void Close ()
 stop the cq query More...
 

Properties

string QueryString [get]
 Get the string for this cq query. More...
 
string Name [get]
 Get the name for this cq query. More...
 
ICqAttributes< TKey, TResult > CqAttributes [get]
 Get the Attributes for this cq query. More...
 
IQuery< TResult > Query [get]
 Get the Query for this cq query. More...
 
CqState State [get]
 get the state of this cq query More...
 
bool IsRunning [get]
 Is this Cq in running state? More...
 
bool IsStopped [get]
 Is this Cq in stopped state? More...
 
bool IsClosed [get]
 Is this Cq in closed state? More...
 

Detailed Description

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

void ICqQuery< TKey, TResult >.Close ( )

stop the cq query

◆ Execute()

void ICqQuery< TKey, TResult >.Execute ( bool  reExecute = false)

Executes the Cq Query on the cache server

◆ ExecuteWithInitialResults()

IReadOnlyCollection<KeyValuePair<TKey, TResult> > ICqQuery< TKey, TResult >.ExecuteWithInitialResults ( )

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

◆ Stop()

void ICqQuery< TKey, TResult >.Stop ( )

stop the cq query

Property Documentation

◆ CqAttributes

ICqAttributes<TKey, TResult> ICqQuery< TKey, TResult >.CqAttributes
get

Get the Attributes for this cq query.

◆ IsClosed

bool ICqQuery< TKey, TResult >.IsClosed
get

Is this Cq in closed state?

◆ IsRunning

bool ICqQuery< TKey, TResult >.IsRunning
get

Is this Cq in running state?

◆ IsStopped

bool ICqQuery< TKey, TResult >.IsStopped
get

Is this Cq in stopped state?

◆ Name

string ICqQuery< TKey, TResult >.Name
get

Get the name for this cq query.

◆ Query

IQuery<TResult> ICqQuery< TKey, TResult >.Query
get

Get the Query for this cq query.

◆ QueryString

string ICqQuery< TKey, TResult >.QueryString
get

Get the string for this cq query.

◆ State

CqState ICqQuery< TKey, TResult >.State
get

get the state of this cq query


The documentation for this interface was generated from the following file:
  • gemfire.client/Interfaces/ICqQuery.cs