Pool.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_POOL_H_
#define GEODE_POOL_H_
 
#include <chrono>
#include <iosfwd>
#include <memory>
 
#include "Cache.hpp"
#include "CacheFactory.hpp"
#include "CacheableBuiltins.hpp"
#include "internal/chrono/duration.hpp"
#include "internal/geode_base.hpp"
#include "internal/geode_globals.hpp"
 
namespace apache {
namespace geode {
namespace client {
 
class AuthenticatedView;
class Cache;
class CacheFactory;
class PoolAttributes;
class CacheImpl;
class Properties;
class QueryService;
 
class APACHE_GEODE_EXPORT Pool : public std::enable_shared_from_this<Pool> {
 public:
  virtual const std::string& getName() const = 0;
 
  std::chrono::milliseconds getFreeConnectionTimeout() const;
 
  std::chrono::milliseconds getLoadConditioningInterval() const;
 
  int getSocketBufferSize() const;
 
  std::chrono::milliseconds getReadTimeout() const;
 
  int getMinConnections() const;
 
  int getMaxConnections() const;
 
  std::chrono::milliseconds getIdleTimeout() const;
 
  std::chrono::milliseconds getPingInterval() const;
 
  std::chrono::milliseconds getUpdateLocatorListInterval() const;
 
  std::chrono::milliseconds getStatisticInterval() const;
 
  int getRetryAttempts() const;
 
  bool getSubscriptionEnabled() const;
 
  int getSubscriptionRedundancy() const;
 
  std::chrono::milliseconds getSubscriptionMessageTrackingTimeout() const;
 
  std::chrono::milliseconds getSubscriptionAckInterval() const;
 
  const std::string& getServerGroup() const;
 
  bool getThreadLocalConnections() const;
 
  bool getMultiuserAuthentication() const;
 
  bool getPRSingleHopEnabled() const;
 
  virtual void releaseThreadLocalConnection() = 0;
 
  virtual const std::shared_ptr<CacheableStringArray> getLocators() const = 0;
 
  virtual const std::shared_ptr<CacheableStringArray> getServers() = 0;
 
  virtual void destroy(bool keepAlive = false) = 0;
 
  virtual bool isDestroyed() const = 0;
 
  virtual std::shared_ptr<QueryService> getQueryService() = 0;
 
  virtual ~Pool();
 
  int getPendingEventCount() const;
 
 protected:
  explicit Pool(std::shared_ptr<PoolAttributes> attr);
  std::shared_ptr<PoolAttributes> m_attrs;
 
 private:
  virtual AuthenticatedView createAuthenticatedView(
      std::shared_ptr<Properties> credentials, CacheImpl* cacheImpl);
 
  Pool(const Pool&);
 
  friend class PoolFactory;
  friend class CacheFactory;
  friend class CacheImpl;
};
 
}  // namespace client
}  // namespace geode
}  // namespace apache
 
#endif  // GEODE_POOL_H_