CqQuery.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_CQQUERY_H_
#define GEODE_CQQUERY_H_

/*
 * 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.
 */

#include "geode_globals.hpp"
#include "geode_types.hpp"

#include "CqResults.hpp"
#include "CqStatistics.hpp"
#include "CqAttributes.hpp"
#include "CqAttributesMutator.hpp"
#include "CqState.hpp"

namespace apache {
namespace geode {
namespace client {

class CPPCACHE_EXPORT CqQuery : public SharedBase {
 public:
  virtual const char* getQueryString() const = 0;
  virtual QueryPtr getQuery() const = 0;
  virtual const char* getName() const = 0;
  virtual const CqStatisticsPtr getStatistics() const = 0;
  virtual const CqAttributesPtr getCqAttributes() const = 0;
  virtual const CqAttributesMutatorPtr getCqAttributesMutator() const = 0;
  virtual CqResultsPtr executeWithInitialResults(
      uint32_t timeout = DEFAULT_QUERY_RESPONSE_TIMEOUT) = 0;

  virtual void execute() = 0;
  virtual void stop() = 0;

  virtual CqState::StateType getState() = 0;

  virtual void close() = 0;

  virtual bool isRunning() = 0;

  virtual bool isStopped() = 0;

  virtual bool isClosed() = 0;

  virtual bool isDurable() = 0;
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_CQQUERY_H_