vmware-gemfire-native-client-c++-api-reference/10.4/a00086_source.html

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */


#pragma once


#ifndef GEODE_CQQUERY_H_

#define GEODE_CQQUERY_H_


#include <chrono>


#include "CqAttributes.hpp"

#include "CqAttributesMutator.hpp"

#include "CqResults.hpp"

#include "CqState.hpp"

#include "CqStatistics.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {

class Query;


class APACHE_GEODE_EXPORT CqQuery {

 public:

  virtual const std::string& getQueryString() const = 0;


  virtual std::shared_ptr<Query> getQuery() const = 0;


  virtual const std::string& getName() const = 0;


  virtual std::shared_ptr<CqStatistics> getStatistics() const = 0;


  virtual std::shared_ptr<CqAttributes> getCqAttributes() const = 0;


  virtual CqAttributesMutator getCqAttributesMutator() const = 0;


  virtual std::shared_ptr<CqResults> executeWithInitialResults(

      std::chrono::milliseconds timeout = DEFAULT_QUERY_RESPONSE_TIMEOUT) = 0;


  virtual void execute() = 0;


  virtual void stop() = 0;


  virtual CqState getState() = 0;


  virtual void close() = 0;


  virtual bool isRunning() const = 0;


  virtual bool isStopped() const = 0;


  virtual bool isClosed() const = 0;


  virtual bool isDurable() const = 0;

};


}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_CQQUERY_H_

CqAttributesMutator.hpp

CqResults.hpp

CqState.hpp

apache::geode::client::CqState
CqState
CqState.hpp.
Definition CqState.hpp:37

CqStatistics.hpp

apache::geode::client::CqAttributesMutator
This interface is used to modify the listeners that are associated with a CQ.
Definition CqAttributesMutator.hpp:43

apache::geode::client::CqQuery
A Query is obtained from a QueryService which in turn is obtained from the Cache.
Definition CqQuery.hpp:54

apache::geode::client::CqQuery::getName
virtual const std::string & getName() const =0
Get the name of the CQ.

apache::geode::client::CqQuery::isClosed
virtual bool isClosed() const =0
This allows to check if the CQ is closed.

apache::geode::client::CqQuery::isDurable
virtual bool isDurable() const =0
This allows to check if the CQ is durable.

apache::geode::client::CqQuery::isStopped
virtual bool isStopped() const =0
This allows to check if the CQ is in stopped.

apache::geode::client::CqQuery::getStatistics
virtual std::shared_ptr< CqStatistics > getStatistics() const =0
Get the statistics information of this CQ.

apache::geode::client::CqQuery::getQueryString
virtual const std::string & getQueryString() const =0
Get the query string provided when a new Query was created from a QueryService.

apache::geode::client::CqQuery::getState
virtual CqState getState()=0
Get the state of the CQ in CqState object form.

apache::geode::client::CqQuery::isRunning
virtual bool isRunning() const =0
This allows to check if the CQ is in running or active.

apache::geode::client::CqQuery::getQuery
virtual std::shared_ptr< Query > getQuery() const =0
Get the query object generated for this CQs query.

apache::geode::client::CqQuery::close
virtual void close()=0
Close the CQ and stop execution.

apache::geode::client::CqQuery::getCqAttributesMutator
virtual CqAttributesMutator getCqAttributesMutator() const =0
Get the AttributesMutator of this CQ.

apache::geode::client::CqQuery::getCqAttributes
virtual std::shared_ptr< CqAttributes > getCqAttributes() const =0
Get the Attributes of this CQ.

apache::geode::client::CqQuery::execute
virtual void execute()=0
Executes the OQL Query on the cache server and returns the results.

apache::geode::client::CqQuery::executeWithInitialResults
virtual std::shared_ptr< CqResults > executeWithInitialResults(std::chrono::milliseconds timeout=DEFAULT_QUERY_RESPONSE_TIMEOUT)=0
Start executing the CQ or if this CQ is stopped earlier, resumes execution of the CQ.

apache::geode::client::CqQuery::stop
virtual void stop()=0
Stops this CqQuery without releasing resources.