Cache.hpp

Go to the documentation of this file.

/*
 * 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_CACHE_H_
#define GEODE_CACHE_H_
 
#include <string>
 
#include "GeodeCache.hpp"
#include "internal/geode_globals.hpp"
 
namespace apache {
namespace geode {
namespace client {
 
class AuthenticatedView;
class AuthInitialize;
class CacheFactory;
class CacheImpl;
class CacheRegionHelper;
class CacheTransactionManager;
class DataInput;
class DataOutput;
class Pool;
class PoolFactory;
class PoolManager;
class Properties;
class QueryService;
class Region;
class RegionFactory;
class TypeRegistry;
enum class RegionShortcut;
 
class APACHE_GEODE_EXPORT Cache : public GeodeCache {
 public:
  virtual RegionFactory createRegionFactory(RegionShortcut regionShortcut);
 
  void initializeDeclarativeCache(const std::string& cacheXml) override;
 
  const std::string& getName() const override;
 
  bool isClosed() const override;
 
  TypeRegistry& getTypeRegistry() const;
 
  void close() override;
 
  virtual void close(bool keepalive);
 
  std::shared_ptr<Region> getRegion(const std::string& path) const override;
 
  std::vector<std::shared_ptr<Region>> rootRegions() const override;
 
  std::shared_ptr<QueryService> getQueryService() override;
 
  virtual std::shared_ptr<QueryService> getQueryService(
      const std::string& poolName) const;
 
  virtual void readyForEvents();
 
  virtual AuthenticatedView createAuthenticatedView(
      const std::shared_ptr<Properties>& userSecurityProperties,
      const std::string& poolName);
 
  virtual std::shared_ptr<CacheTransactionManager> getCacheTransactionManager()
      const;
 
  bool getPdxIgnoreUnreadFields() const override;
 
  bool getPdxReadSerialized() const override;
 
  PdxInstanceFactory createPdxInstanceFactory(
      const std::string& className) const override;
 
  virtual DataInput createDataInput(const uint8_t* m_buffer, size_t len) const;
 
  virtual DataOutput createDataOutput() const;
 
  virtual PoolManager& getPoolManager() const;
 
  SystemProperties& getSystemProperties() const override;
 
  Cache() = delete;
  virtual ~Cache();
  Cache(const Cache& other) = delete;
  Cache& operator=(const Cache& other) = delete;
  Cache(Cache&& other) noexcept;
  Cache& operator=(Cache&& other) noexcept;
 
 private:
  Cache(const std::shared_ptr<Properties>& dsProp, bool ignorePdxUnreadFields,
        bool readPdxSerialized,
        const std::shared_ptr<AuthInitialize>& authInitialize);
 
  std::unique_ptr<CacheImpl> m_cacheImpl;
 
 protected:
  static bool isPoolInMultiuserMode(std::shared_ptr<Region> regionPtr);
 
  friend class CacheFactory;
  friend class CacheRegionHelper;
  friend class FunctionService;
  friend class CacheXmlCreation;
  friend class RegionXmlCreation;
};
}  // namespace client
}  // namespace geode
}  // namespace apache
 
#endif  // GEODE_CACHE_H_