RegionFactory.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_REGIONFACTORY_H_
#define GEODE_REGIONFACTORY_H_
 
#include <chrono>
 
#include "RegionAttributesFactory.hpp"
#include "internal/chrono/duration.hpp"
#include "internal/geode_globals.hpp"
 
namespace apache {
namespace geode {
namespace client {
class CacheImpl;
 
class APACHE_GEODE_EXPORT RegionFactory {
 public:
  RegionFactory() = delete;
  ~RegionFactory() = default;
  RegionFactory(const RegionFactory& nocopy) = delete;
  RegionFactory(RegionFactory&& move) = default;
 
  std::shared_ptr<Region> create(std::string name);
 
  RegionFactory& setCacheLoader(
      const std::shared_ptr<CacheLoader>& cacheLoader);
 
  RegionFactory& setCacheWriter(
      const std::shared_ptr<CacheWriter>& cacheWriter);
 
  RegionFactory& setCacheListener(
      const std::shared_ptr<CacheListener>& aListener);
 
  RegionFactory& setPartitionResolver(
      const std::shared_ptr<PartitionResolver>& aResolver);
 
  RegionFactory& setCacheLoader(const std::string& libpath,
                                const std::string& factoryFuncName);
 
  RegionFactory& setCacheWriter(const std::string& libpath,
                                const std::string& factoryFuncName);
 
  RegionFactory& setCacheListener(const std::string& libpath,
                                  const std::string& factoryFuncName);
 
  RegionFactory& setPartitionResolver(const std::string& libpath,
                                      const std::string& factoryFuncName);
 
  // EXPIRATION ATTRIBUTES
 
  RegionFactory& setEntryIdleTimeout(ExpirationAction action,
                                     std::chrono::seconds idleTimeout);
 
  RegionFactory& setEntryTimeToLive(ExpirationAction action,
                                    std::chrono::seconds timeToLive);
 
  RegionFactory& setRegionIdleTimeout(ExpirationAction action,
                                      std::chrono::seconds idleTimeout);
 
  RegionFactory& setRegionTimeToLive(ExpirationAction action,
                                     std::chrono::seconds timeToLive);
 
  // PERSISTENCE
  RegionFactory& setPersistenceManager(
      const std::string& libpath, const std::string& factoryFuncName,
      const std::shared_ptr<Properties>& config = nullptr);
 
  RegionFactory& setPersistenceManager(
      const std::shared_ptr<PersistenceManager>& persistenceManager,
      const std::shared_ptr<Properties>& config = nullptr);
 
  // MAP ATTRIBUTES
  RegionFactory& setInitialCapacity(int initialCapacity);
 
  RegionFactory& setLoadFactor(float loadFactor);
 
  RegionFactory& setConcurrencyLevel(uint8_t concurrencyLevel);
 
  RegionFactory& setLruEntriesLimit(const uint32_t entriesLimit);
 
  RegionFactory& setDiskPolicy(const DiskPolicyType diskPolicy);
 
  RegionFactory& setCachingEnabled(bool cachingEnabled);
 
  /*
   * Set the PoolName to attach the Region with that Pool.
   * Use only when Cache ha more than one Pool
   * @param name
   *        the name of the Pool to which region will be attached.
   * @return a reference to <code>this</code>
   */
  RegionFactory& setPoolName(const std::string& name);
 
  /*
   * Set boolean to enable/disable cloning while applying delta.
   * @param isClonable whether to enable cloning or not.
   * @return a reference to <code>this</code>
   */
  RegionFactory& setCloningEnabled(bool isClonable);
 
  RegionFactory& setConcurrencyChecksEnabled(bool enable);
 
 private:
  RegionFactory(apache::geode::client::RegionShortcut preDefinedRegion,
                CacheImpl* cacheImpl);
 
  void setRegionShortcut();
 
  RegionShortcut m_preDefinedRegion;
 
  std::shared_ptr<RegionAttributesFactory> m_regionAttributesFactory;
 
  CacheImpl* m_cacheImpl;
 
  friend class CacheImpl;
};
 
}  // namespace client
}  // namespace geode
}  // namespace apache
 
#endif  // GEODE_REGIONFACTORY_H_