Apache Geode Native C++ Reference 1.15.0
RegionService.hpp
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
29namespace apache {
30namespace geode {
31namespace client {
32
33class Region;
34class QueryService;
35
58class APACHE_GEODE_EXPORT RegionService {
59 public:
60 virtual ~RegionService() = 0;
61
70 virtual bool isClosed() const = 0;
71
82 virtual void close() = 0;
83
89 virtual std::shared_ptr<Region> getRegion(const std::string& name) const = 0;
90
95 virtual std::shared_ptr<QueryService> getQueryService() = 0;
96
102 virtual std::vector<std::shared_ptr<Region>> rootRegions() const = 0;
103
111 const std::string& className) const = 0;
112
123 const std::string& className, bool expectDomainClass) const = 0;
124};
125
126} // namespace client
127} // namespace geode
128} // namespace apache
129
130#endif // GEODE_REGIONSERVICE_H_
PdxInstanceFactory gives you a way to create PdxInstances.
Definition: PdxInstanceFactory.hpp:52
A RegionService provides access to existing regions that exist in a Geode cache.
Definition: RegionService.hpp:58
virtual bool isClosed() const =0
Indicates if this cache has been closed.
virtual PdxInstanceFactory createPdxInstanceFactory(const std::string &className) const =0
Returns a factory that can create a PdxInstance.
virtual std::shared_ptr< Region > getRegion(const std::string &name) const =0
Look up a region with the name.
virtual std::shared_ptr< QueryService > getQueryService()=0
Gets the QueryService from which a new Query can be obtained.
virtual std::vector< std::shared_ptr< Region > > rootRegions() const =0
Returns a set of root regions in the cache.
virtual void close()=0
Terminates this object cache and releases all the local resources.
virtual PdxInstanceFactory createPdxInstanceFactory(const std::string &className, bool expectDomainClass) const =0
Returns a factory that can create a PdxInstance.

Apache Geode C++ Cache API Documentation