arangodb/lib/SimpleHttpClient/ConnectionManager.h

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// Licensed 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Max Neunhoeffer
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGODB_SIMPLE_HTTP_CLIENT_CONNECTION_MANAGER_H
#define ARANGODB_SIMPLE_HTTP_CLIENT_CONNECTION_MANAGER_H 1

#include "Basics/Common.h"
#include "Basics/ReadWriteLock.h"
#include "SimpleHttpClient/GeneralClientConnection.h"

#include <list>


namespace arangodb {
namespace httpclient {

////////////////////////////////////////////////////////////////////////////////
/// @brief number of buckets
////////////////////////////////////////////////////////////////////////////////

constexpr size_t ConnectionManagerBuckets() { return 8; }

////////////////////////////////////////////////////////////////////////////////
/// @brief options for connections
////////////////////////////////////////////////////////////////////////////////

struct ConnectionOptions {
  double _connectTimeout;
  double _requestTimeout;
  size_t _connectRetries;
  double _singleRequestTimeout;
  uint32_t _sslProtocol;
};

////////////////////////////////////////////////////////////////////////////////
/// @brief the class to manage open client connections
////////////////////////////////////////////////////////////////////////////////

class ConnectionManager {
  //////////////////////////////////////////////////////////////////////////////
  /// @brief initializes library
  ///
  /// We are a singleton class, therefore nobody is allowed to create
  /// new instances or copy them, except we ourselves.
  //////////////////////////////////////////////////////////////////////////////

 private:
  ConnectionManager() = default;

  ConnectionManager(ConnectionManager const&) = delete;
  ConnectionManager& operator=(ConnectionManager const&) = delete;

 public:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief shuts down library
  //////////////////////////////////////////////////////////////////////////////

  ~ConnectionManager();

  //////////////////////////////////////////////////////////////////////////////
  /// @brief initializes library
  //////////////////////////////////////////////////////////////////////////////

  static void initialize();

  struct ServerConnections;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief class to administrate one connection to a server
  //////////////////////////////////////////////////////////////////////////////

  struct SingleServerConnection {
    ServerConnections* _connections;
    GeneralClientConnection* _connection;
    Endpoint* _endpoint;
    std::string const _endpointSpecification;
    time_t _lastUsed;

    SingleServerConnection(ServerConnections* manager,
                           GeneralClientConnection* connection,
                           Endpoint* endpoint,
                           std::string const& endpointSpecification)
        : _connections(manager),
          _connection(connection),
          _endpoint(endpoint),
          _endpointSpecification(endpointSpecification),
          _lastUsed(::time(0)) {}

    ~SingleServerConnection();
  };

  //////////////////////////////////////////////////////////////////////////////
  /// @brief class to administrate all connections to a server
  //////////////////////////////////////////////////////////////////////////////

  struct ServerConnections {
    std::vector<SingleServerConnection*> _connections;
    std::list<SingleServerConnection*> _unused;
    arangodb::basics::ReadWriteLock _lock;

    ServerConnections() = default;

    ~ServerConnections();  // closes all connections

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief adds a single connection
    ////////////////////////////////////////////////////////////////////////////////

    void addConnection(SingleServerConnection*);

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief pop a free connection - returns nullptr if no connection is
    /// available
    ////////////////////////////////////////////////////////////////////////////////

    SingleServerConnection* popConnection();

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief push a unused connection back on the stack, allowing its re-use
    ////////////////////////////////////////////////////////////////////////////////

    void pushConnection(SingleServerConnection*);

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief remove a (broken) connection from the list of connections
    ////////////////////////////////////////////////////////////////////////////////

    void removeConnection(SingleServerConnection*);

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief closes unused connections
    ////////////////////////////////////////////////////////////////////////////////

    void closeUnusedConnections(double);
  };

  //////////////////////////////////////////////////////////////////////////////
  /// @brief get the unique instance
  //////////////////////////////////////////////////////////////////////////////

  static ConnectionManager* instance();

  //////////////////////////////////////////////////////////////////////////////
  /// @brief open or get a previously cached connection to a server
  //////////////////////////////////////////////////////////////////////////////

  SingleServerConnection* leaseConnection(std::string const& endpoint);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief return leased connection to a server
  //////////////////////////////////////////////////////////////////////////////

  void returnConnection(SingleServerConnection* singleConnection);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief report a leased connection as being broken
  //////////////////////////////////////////////////////////////////////////////

  void brokenConnection(SingleServerConnection* singleConnection);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief closes all connections that have been unused for more than
  /// limit seconds
  //////////////////////////////////////////////////////////////////////////////

  void closeUnusedConnections(double limit);

 private:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief hash the endpoint value into a bucket
  //////////////////////////////////////////////////////////////////////////////

  size_t bucket(std::string const& endpoint) const {
    return std::hash<std::string>()(endpoint) % ConnectionManagerBuckets();
  }

  //////////////////////////////////////////////////////////////////////////////
  /// @brief global options for connections
  //////////////////////////////////////////////////////////////////////////////

  static ConnectionOptions _globalConnectionOptions;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief map to store all connections to all servers with corresponding lock
  //////////////////////////////////////////////////////////////////////////////

  // We keep connections to servers open:
#ifdef _WIN32
  struct ConnectionsBucket {
#else
  struct alignas(64) ConnectionsBucket {
#endif
    std::unordered_map<std::string, ServerConnections*> _connections;

    arangodb::basics::ReadWriteLock _lock;
  };

  ConnectionsBucket _connectionsBuckets[ConnectionManagerBuckets()];
};
}
}
#endif