RegionAttributesFactory.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_ATTRIBUTESFACTORY_H_
#define GEODE_ATTRIBUTESFACTORY_H_
 
#include <chrono>
#include <string>
 
#include "CacheListener.hpp"
#include "CacheLoader.hpp"
#include "CacheWriter.hpp"
#include "DiskPolicyType.hpp"
#include "ExceptionTypes.hpp"
#include "ExpirationAction.hpp"
#include "PartitionResolver.hpp"
#include "Pool.hpp"
#include "RegionAttributes.hpp"
#include "internal/chrono/duration.hpp"
#include "internal/geode_globals.hpp"
 
namespace apache {
namespace geode {
namespace client {
 
class APACHE_GEODE_EXPORT RegionAttributesFactory {
 public:
  RegionAttributesFactory();
 
  explicit RegionAttributesFactory(const RegionAttributes regionAttributes);
 
  RegionAttributesFactory(const RegionAttributesFactory&) = default;
 
  virtual ~RegionAttributesFactory();
 
  // CALLBACKS
 
  RegionAttributesFactory& setCacheLoader(
      const std::shared_ptr<CacheLoader>& cacheLoader);
 
  RegionAttributesFactory& setCacheWriter(
      const std::shared_ptr<CacheWriter>& cacheWriter);
 
  RegionAttributesFactory& setCacheListener(
      const std::shared_ptr<CacheListener>& aListener);
 
  RegionAttributesFactory& setPartitionResolver(
      const std::shared_ptr<PartitionResolver>& aResolver);
 
  RegionAttributesFactory& setCacheLoader(const std::string& libpath,
                                          const std::string& factoryFuncName);
 
  RegionAttributesFactory& setCacheWriter(const std::string& libpath,
                                          const std::string& factoryFuncName);
 
  RegionAttributesFactory& setCacheListener(const std::string& libpath,
                                            const std::string& factoryFuncName);
 
  RegionAttributesFactory& setPartitionResolver(
      const std::string& libpath, const std::string& factoryFuncName);
 
  // EXPIRATION ATTRIBUTES
 
  RegionAttributesFactory& setEntryIdleTimeout(
      ExpirationAction action, std::chrono::seconds idleTimeout);
 
  RegionAttributesFactory& setEntryTimeToLive(ExpirationAction action,
                                              std::chrono::seconds timeToLive);
 
  RegionAttributesFactory& setRegionIdleTimeout(
      ExpirationAction action, std::chrono::seconds idleTimeout);
 
  RegionAttributesFactory& setRegionTimeToLive(ExpirationAction action,
                                               std::chrono::seconds timeToLive);
 
  // PERSISTENCE
  RegionAttributesFactory& setPersistenceManager(
      const std::string& libpath, const std::string& factoryFuncName,
      const std::shared_ptr<Properties>& config = nullptr);
 
  RegionAttributesFactory& setPersistenceManager(
      const std::shared_ptr<PersistenceManager>& persistenceManager,
      const std::shared_ptr<Properties>& config = nullptr);
 
  // MAP ATTRIBUTES
  RegionAttributesFactory& setInitialCapacity(int32_t initialCapacity);
 
  RegionAttributesFactory& setLoadFactor(float loadFactor);
 
  RegionAttributesFactory& setConcurrencyLevel(uint8_t concurrencyLevel);
 
  RegionAttributesFactory& setLruEntriesLimit(const uint32_t entriesLimit);
 
  RegionAttributesFactory& setDiskPolicy(const DiskPolicyType diskPolicy);
 
  RegionAttributesFactory& setCachingEnabled(bool cachingEnabled);
 
  RegionAttributesFactory& setPoolName(const std::string& name);
 
  RegionAttributesFactory& setCloningEnabled(bool isClonable);
 
  RegionAttributesFactory& setConcurrencyChecksEnabled(
      bool concurrencyChecksEnabled);
 
  // FACTORY METHOD
 
  RegionAttributes create();
 
 private:
  RegionAttributesFactory& operator=(const RegionAttributesFactory& other) =
      default;
  RegionAttributes m_regionAttributes;
  static void validateAttributes(RegionAttributes& attrs);
};  // namespace client
 
}  // namespace client
}  // namespace geode
}  // namespace apache
 
#endif  // GEODE_ATTRIBUTESFACTORY_H_