PoolFactory.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_POOLFACTORY_H_
#define GEODE_POOLFACTORY_H_
 
#include <chrono>
 
#include "Pool.hpp"
#include "internal/chrono/duration.hpp"
#include "internal/geode_globals.hpp"
 
namespace apache {
namespace geode {
namespace client {
 
class CacheImpl;
class PoolAttributes;
class Pool;
 
class APACHE_GEODE_EXPORT PoolFactory {
 public:
  static const std::chrono::milliseconds DEFAULT_FREE_CONNECTION_TIMEOUT;
 
  static const std::chrono::milliseconds DEFAULT_LOAD_CONDITIONING_INTERVAL;
 
  static const int DEFAULT_SOCKET_BUFFER_SIZE = 32768;
 
  static const std::chrono::milliseconds DEFAULT_READ_TIMEOUT;
 
  static const int DEFAULT_MIN_CONNECTIONS = 1;
 
  static const int DEFAULT_MAX_CONNECTIONS = -1;
 
  static const std::chrono::milliseconds DEFAULT_IDLE_TIMEOUT;
 
  static const int DEFAULT_RETRY_ATTEMPTS = -1;
 
  static const std::chrono::milliseconds DEFAULT_PING_INTERVAL;
 
  static const std::chrono::milliseconds DEFAULT_UPDATE_LOCATOR_LIST_INTERVAL;
 
  static const std::chrono::milliseconds DEFAULT_STATISTIC_INTERVAL;
 
  static const bool DEFAULT_SUBSCRIPTION_ENABLED = false;
 
  static const int DEFAULT_SUBSCRIPTION_REDUNDANCY = 0;
 
  static const std::chrono::milliseconds
      DEFAULT_SUBSCRIPTION_MESSAGE_TRACKING_TIMEOUT;
 
  static const std::chrono::milliseconds DEFAULT_SUBSCRIPTION_ACK_INTERVAL;
 
  static const std::string DEFAULT_SERVER_GROUP;
  static constexpr bool DEFAULT_THREAD_LOCAL_CONN = false;
 
  static constexpr bool DEFAULT_MULTIUSER_SECURE_MODE = false;
 
  static constexpr bool DEFAULT_PR_SINGLE_HOP_ENABLED = true;
 
  PoolFactory& setFreeConnectionTimeout(
      std::chrono::milliseconds connectionTimeout);
 
  PoolFactory& setLoadConditioningInterval(
      std::chrono::milliseconds loadConditioningInterval);
 
  PoolFactory& setSocketBufferSize(int bufferSize);
 
  PoolFactory& setThreadLocalConnections(bool threadLocalConnections);
 
  PoolFactory& setReadTimeout(std::chrono::milliseconds timeout);
 
  PoolFactory& setMinConnections(int minConnections);
 
  PoolFactory& setMaxConnections(int maxConnections);
 
  PoolFactory& setIdleTimeout(std::chrono::milliseconds);
 
  PoolFactory& setRetryAttempts(int retryAttempts);
 
  PoolFactory& setPingInterval(std::chrono::milliseconds pingInterval);
 
  PoolFactory& setUpdateLocatorListInterval(
      std::chrono::milliseconds updateLocatorListInterval);
 
  PoolFactory& setStatisticInterval(
      std::chrono::milliseconds statisticInterval);
 
  PoolFactory& setServerGroup(std::string group);
 
  PoolFactory& addLocator(const std::string& host, int port);
 
  PoolFactory& addServer(const std::string& host, int port);
 
  PoolFactory& setSniProxy(std::string hostname, uint16_t port);
 
  PoolFactory& setSubscriptionEnabled(bool enabled);
 
  PoolFactory& setSubscriptionRedundancy(int redundancy);
 
  PoolFactory& setSubscriptionMessageTrackingTimeout(
      std::chrono::milliseconds messageTrackingTimeout);
 
  PoolFactory& setSubscriptionAckInterval(
      std::chrono::milliseconds ackInterval);
 
  PoolFactory& setMultiuserAuthentication(bool multiuserAuthentication);
 
  PoolFactory& reset();
 
  std::shared_ptr<Pool> create(std::string name);
 
  PoolFactory& setPRSingleHopEnabled(bool enabled);
 
  ~PoolFactory() = default;
 
  PoolFactory(const PoolFactory&) = default;
 
 private:
  explicit PoolFactory(const Cache& cache);
  std::shared_ptr<PoolAttributes> m_attrs;
  bool m_isSubscriptionRedundancy;
  bool m_addedServerOrLocator;
  const Cache& m_cache;
 
  friend class Cache;
  friend class PoolManager;
  friend class PoolManagerImpl;
  friend class CacheFactory;
  friend class CacheXmlCreation;
};
 
}  // namespace client
}  // namespace geode
}  // namespace apache
 
#endif  // GEODE_POOLFACTORY_H_