vmware-gemfire-native-client-c++-api-reference/latest/a00221_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_REGIONSERVICE_H_

#define GEODE_REGIONSERVICE_H_


#include <memory>

#include <vector>


#include "PdxInstanceFactory.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


class Region;

class QueryService;


class APACHE_GEODE_EXPORT RegionService {

 public:

  virtual ~RegionService() = 0;


  virtual bool isClosed() const = 0;


  virtual void close() = 0;


  virtual std::shared_ptr<Region> getRegion(const std::string& name) const = 0;


  virtual std::shared_ptr<QueryService> getQueryService() = 0;


  virtual std::vector<std::shared_ptr<Region>> rootRegions() const = 0;


  virtual PdxInstanceFactory createPdxInstanceFactory(

      const std::string& className) const = 0;


  virtual PdxInstanceFactory createPdxInstanceFactory(

      const std::string& className, bool expectDomainClass) const = 0;

};


}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_REGIONSERVICE_H_

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:58

apache::geode::client::RegionService::isClosed
virtual bool isClosed() const =0
Indicates if this cache has been closed.

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::getRegion
virtual std::shared_ptr< Region > getRegion(const std::string &name) const =0
Look up a region with the name.

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::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::close
virtual void close()=0
Terminates this object cache and releases all the local resources.

apache::geode::client::RegionService::createPdxInstanceFactory
virtual PdxInstanceFactory createPdxInstanceFactory(const std::string &className, bool expectDomainClass) const =0
Returns a factory that can create a PdxInstance.