AttributesFactory.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_ATTRIBUTESFACTORY_H_
#define GEODE_ATTRIBUTESFACTORY_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 "ExceptionTypes.hpp"
#include "ExpirationAction.hpp"
#include "CacheLoader.hpp"
#include "CacheWriter.hpp"
#include "CacheListener.hpp"
#include "PartitionResolver.hpp"
#include "RegionAttributes.hpp"
#include "DiskPolicyType.hpp"
#include "Pool.hpp"

namespace apache {
namespace geode {
namespace client {

class CPPCACHE_EXPORT AttributesFactory : public SharedBase {
 public:
  AttributesFactory();

  AttributesFactory(const RegionAttributesPtr& regionAttributes);

  virtual ~AttributesFactory();

  // CALLBACKS

  void setCacheLoader(const CacheLoaderPtr& cacheLoader);

  void setCacheWriter(const CacheWriterPtr& cacheWriter);

  void setCacheListener(const CacheListenerPtr& aListener);

  void setPartitionResolver(const PartitionResolverPtr& aResolver);

  void setCacheLoader(const char* libpath, const char* factoryFuncName);

  void setCacheWriter(const char* libpath, const char* factoryFuncName);

  void setCacheListener(const char* libpath, const char* factoryFuncName);

  void setPartitionResolver(const char* libpath, const char* factoryFuncName);

  // EXPIRATION ATTRIBUTES

  void setEntryIdleTimeout(ExpirationAction::Action action,
                           int32_t idleTimeout);

  void setEntryTimeToLive(ExpirationAction::Action action, int32_t timeToLive);

  void setRegionIdleTimeout(ExpirationAction::Action action,
                            int32_t idleTimeout);

  void setRegionTimeToLive(ExpirationAction::Action action, int32_t timeToLive);

  // PERSISTENCE
  void setPersistenceManager(const char* libpath, const char* factoryFuncName,
                             const PropertiesPtr& config = NULLPTR);

  void setPersistenceManager(const PersistenceManagerPtr& persistenceManager,
                             const PropertiesPtr& config = NULLPTR);

 public:
  // DISTRIBUTION ATTRIBUTES

  // MAP ATTRIBUTES
  void setInitialCapacity(int initialCapacity);

  void setLoadFactor(float loadFactor);

  void setConcurrencyLevel(uint8_t concurrencyLevel);

  void setLruEntriesLimit(const uint32_t entriesLimit);

  void setDiskPolicy(const DiskPolicyType::PolicyType diskPolicy);

  void setCachingEnabled(bool cachingEnabled);

  void setPoolName(const char* name);

  void setCloningEnabled(bool isClonable);

  void setConcurrencyChecksEnabled(bool concurrencyChecksEnabled);

  // FACTORY METHOD

  RegionAttributesPtr createRegionAttributes();

 private:
  RegionAttributes m_regionAttributes;
  static void validateAttributes(RegionAttributes& attrs);
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_ATTRIBUTESFACTORY_H_