Cache.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_CACHE_H_
#define GEODE_CACHE_H_

/*
 * 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.
 */
#include "geode_globals.hpp"
#include "geode_types.hpp"
#include "GeodeCache.hpp"
#include "geode_types.hpp"
#include "Region.hpp"
#include "DistributedSystem.hpp"
#include "QueryService.hpp"
#include "PoolFactory.hpp"
#include "RegionShortcut.hpp"
#include "RegionFactory.hpp"
#include "InternalCacheTransactionManager2PC.hpp"

namespace apache {
namespace geode {
namespace client {

class CacheFactory;
class CacheRegionHelper;
class Pool;

class CPPCACHE_EXPORT Cache : public GeodeCache {
 public:
  virtual RegionFactoryPtr createRegionFactory(RegionShortcut regionShortcut);

  virtual void initializeDeclarativeCache(const char* cacheXml);

  virtual const char* getName() const;

  virtual bool isClosed() const;

  virtual DistributedSystemPtr getDistributedSystem() const;

  virtual void close();

  virtual void close(bool keepalive);

  virtual RegionPtr getRegion(const char* path);

  virtual void rootRegions(VectorOfRegion& regions);

  virtual QueryServicePtr getQueryService();

  virtual QueryServicePtr getQueryService(const char* poolName);

  virtual void readyForEvents();

  virtual RegionServicePtr createAuthenticatedView(
      PropertiesPtr userSecurityProperties, const char* poolName = NULL);

  virtual CacheTransactionManagerPtr getCacheTransactionManager();

  virtual bool getPdxIgnoreUnreadFields();

  virtual bool getPdxReadSerialized();

  virtual PdxInstanceFactoryPtr createPdxInstanceFactory(const char* className);

  virtual ~Cache();

 private:
  Cache(const char* name, DistributedSystemPtr sys, bool ignorePdxUnreadFields,
        bool readPdxSerialized);
  Cache(const char* name, DistributedSystemPtr sys, const char* id_data,
        bool ignorePdxUnreadFields, bool readPdxSerialized);
  CacheImpl* m_cacheImpl;

 protected:
  Cache() { m_cacheImpl = NULL; }

  static bool isPoolInMultiuserMode(RegionPtr regionPtr);

  friend class CacheFactory;
  friend class CacheRegionHelper;
  friend class Pool;
  friend class FunctionService;
  friend class CacheXmlCreation;
  friend class RegionXmlCreation;
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_CACHE_H_