vmware-gemfire-native-client-c++-api-reference/10.4/a00131_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_EXECUTION_H_

#define GEODE_EXECUTION_H_


#include <chrono>

#include <memory>

#include <string>


#include "CacheableBuiltins.hpp"

#include "ResultCollector.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


class ExecutionImpl;

class FunctionService;


class APACHE_GEODE_EXPORT Execution {

 public:

  Execution();

  ~Execution() noexcept;

  Execution(Execution&& move) noexcept;

  Execution& operator=(Execution&& move) noexcept;


  Execution withFilter(std::shared_ptr<CacheableVector> routingObj);

  Execution withArgs(std::shared_ptr<Cacheable> args);

  Execution withCollector(std::shared_ptr<ResultCollector> rs);

  std::shared_ptr<ResultCollector> execute(

      const std::string& func,

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


  std::shared_ptr<ResultCollector> execute(

      const std::shared_ptr<CacheableVector>& routingObj,

      const std::shared_ptr<Cacheable>& args,

      const std::shared_ptr<ResultCollector>& rs, const std::string& func,

      std::chrono::milliseconds timeout);


 private:

  std::unique_ptr<ExecutionImpl> impl_;


  explicit Execution(std::unique_ptr<ExecutionImpl> impl);


  friend ExecutionImpl;

  friend FunctionService;

};


}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_EXECUTION_H_

CacheableBuiltins.hpp
Contains generic template definitions for Cacheable types and instantiations for built-in types.

ResultCollector.hpp

apache::geode::client::Execution
gathers results from function execution
Definition Execution.hpp:47

apache::geode::client::Execution::withArgs
Execution withArgs(std::shared_ptr< Cacheable > args)
Specifies the user data passed to the function when it is executed.

apache::geode::client::Execution::withCollector
Execution withCollector(std::shared_ptr< ResultCollector > rs)
Specifies the ResultCollector that will receive the results after the function has been executed.

apache::geode::client::Execution::execute
std::shared_ptr< ResultCollector > execute(const std::shared_ptr< CacheableVector > &routingObj, const std::shared_ptr< Cacheable > &args, const std::shared_ptr< ResultCollector > &rs, const std::string &func, std::chrono::milliseconds timeout)
Executes the function using its name.

apache::geode::client::Execution::execute
std::shared_ptr< ResultCollector > execute(const std::string &func, std::chrono::milliseconds timeout=DEFAULT_QUERY_RESPONSE_TIMEOUT)
Executes the function using its name.

apache::geode::client::Execution::withFilter
Execution withFilter(std::shared_ptr< CacheableVector > routingObj)
Specifies a data filter of routing objects for selecting the Geode members to execute the function.

apache::geode::client::FunctionService
entry point for function execution
Definition FunctionService.hpp:45