VMware Tanzu GemFire Native C++ Reference  10.1.5
RegionService.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #pragma once
19 
20 #ifndef GEODE_REGIONSERVICE_H_
21 #define GEODE_REGIONSERVICE_H_
22 
23 #include <memory>
24 #include <vector>
25 
26 #include "PdxInstanceFactory.hpp"
27 #include "internal/geode_globals.hpp"
28 
33 namespace apache {
34 namespace geode {
35 namespace client {
36 
37 class Region;
38 class QueryService;
39 
62 class APACHE_GEODE_EXPORT RegionService {
66  public:
75  virtual bool isClosed() const = 0;
76 
87  virtual void close() = 0;
88 
94  virtual std::shared_ptr<Region> getRegion(const std::string& name) const = 0;
95 
100  virtual std::shared_ptr<QueryService> getQueryService() = 0;
101 
110  virtual std::vector<std::shared_ptr<Region>> rootRegions() const = 0;
111 
120  const std::string& className) const = 0;
121 };
122 } // namespace client
123 } // namespace geode
124 } // namespace apache
125 
126 #endif // GEODE_REGIONSERVICE_H_
apache::geode::client::RegionService::isClosed
virtual bool isClosed() const =0
public methods
apache::geode::client::RegionService::close
virtual void close()=0
Terminates this object cache and releases all the local resources.
apache::geode::client::PdxInstanceFactory
PdxInstanceFactory gives you a way to create PdxInstances.
Definition: PdxInstanceFactory.hpp:52
apache::geode::client::RegionService
A RegionService provides access to existing regions that exist in a Geode cache.
Definition: RegionService.hpp:62
apache::geode::client::RegionService::getRegion
virtual std::shared_ptr< Region > getRegion(const std::string &name) const =0
Look up a region with the name.
apache::geode::client::RegionService::rootRegions
virtual std::vector< std::shared_ptr< Region > > rootRegions() const =0
Returns a set of root regions in the cache.
apache::geode::client::RegionService::createPdxInstanceFactory
virtual PdxInstanceFactory createPdxInstanceFactory(const std::string &className) const =0
Returns a factory that can create a PdxInstance.
apache::geode::client::RegionService::getQueryService
virtual std::shared_ptr< QueryService > getQueryService()=0
Gets the QueryService from which a new Query can be obtained.

Apache Geode C++ Cache API Documentation