arangodb/arangod/HttpServer/HttpServer.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 Dr. Frank Celler
/// @author Achim Brandt
/// @author Jan Steemann
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_HTTP_SERVER_HTTP_SERVER_H
#define ARANGOD_HTTP_SERVER_HTTP_SERVER_H 1

#include "Basics/Mutex.h"
#include "HttpServer/HttpHandler.h"
#include "Rest/ConnectionInfo.h"
#include "Scheduler/TaskManager.h"

namespace arangodb {
namespace rest {

class AsyncJobManager;
class Dispatcher;
class EndpointList;
class HttpServerJob;
class HttpCommTask;
class HttpHandlerFactory;
class Job;
class ListenTask;

////////////////////////////////////////////////////////////////////////////////
/// @brief general server
////////////////////////////////////////////////////////////////////////////////

class HttpServer : protected TaskManager {
  HttpServer(HttpServer const&) = delete;
  HttpServer const& operator=(HttpServer const&) = delete;

 public:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief destroys an endpoint server
  //////////////////////////////////////////////////////////////////////////////

  static int sendChunk(uint64_t, std::string const&);

 public:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief constructs a new general server with dispatcher and job manager
  //////////////////////////////////////////////////////////////////////////////

  HttpServer(Scheduler*, Dispatcher*, HttpHandlerFactory*, AsyncJobManager*,
             double keepAliveTimeout);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief destructs a general server
  //////////////////////////////////////////////////////////////////////////////

  virtual ~HttpServer();

 public:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief returns the protocol
  //////////////////////////////////////////////////////////////////////////////

  virtual char const* protocol() const { return "http"; }

  //////////////////////////////////////////////////////////////////////////////
  /// @brief returns the encryption to be used
  //////////////////////////////////////////////////////////////////////////////

  virtual Endpoint::EncryptionType encryptionType() const {
    return Endpoint::ENCRYPTION_NONE;
  }

  //////////////////////////////////////////////////////////////////////////////
  /// @brief generates a suitable communication task
  //////////////////////////////////////////////////////////////////////////////

  virtual HttpCommTask* createCommTask(TRI_socket_t, const ConnectionInfo&);

 public:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief returns the scheduler
  //////////////////////////////////////////////////////////////////////////////

  Scheduler* scheduler() const { return _scheduler; }

  //////////////////////////////////////////////////////////////////////////////
  /// @brief returns the dispatcher
  //////////////////////////////////////////////////////////////////////////////

  Dispatcher* dispatcher() const { return _dispatcher; }

  //////////////////////////////////////////////////////////////////////////////
  /// @brief returns the dispatcher
  //////////////////////////////////////////////////////////////////////////////

  AsyncJobManager* jobManager() const { return _jobManager; }

  //////////////////////////////////////////////////////////////////////////////
  /// @brief return the handler factory
  //////////////////////////////////////////////////////////////////////////////

  HttpHandlerFactory* handlerFactory() const { return _handlerFactory; }

  //////////////////////////////////////////////////////////////////////////////
  /// @brief adds the endpoint list
  //////////////////////////////////////////////////////////////////////////////

  void setEndpointList(const EndpointList* list);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief starts listening
  //////////////////////////////////////////////////////////////////////////////

  void startListening();

  //////////////////////////////////////////////////////////////////////////////
  /// @brief stops listining
  //////////////////////////////////////////////////////////////////////////////

  void stopListening();

  //////////////////////////////////////////////////////////////////////////////
  /// @brief removes all listen and comm tasks
  //////////////////////////////////////////////////////////////////////////////

  void stop();

  //////////////////////////////////////////////////////////////////////////////
  /// @brief handles connection request
  //////////////////////////////////////////////////////////////////////////////

  void handleConnected(TRI_socket_t s, const ConnectionInfo& info);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief handles a connection close
  //////////////////////////////////////////////////////////////////////////////

  void handleCommunicationClosed(HttpCommTask*);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief handles a connection failure
  //////////////////////////////////////////////////////////////////////////////

  void handleCommunicationFailure(HttpCommTask*);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief creates a job for asynchronous execution
  //////////////////////////////////////////////////////////////////////////////

  bool handleRequestAsync(arangodb::WorkItem::uptr<HttpHandler>&,
                          uint64_t* jobId);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief executes the handler directly or add it to the queue
  //////////////////////////////////////////////////////////////////////////////

  bool handleRequest(HttpCommTask*, arangodb::WorkItem::uptr<HttpHandler>&);

 protected:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief Handler, Job, and Task tuple
  //////////////////////////////////////////////////////////////////////////////

  struct handler_task_job_t {
    HttpHandler* _handler;
    HttpCommTask* _task;
    HttpServerJob* _job;
  };

 protected:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief opens a listen port
  //////////////////////////////////////////////////////////////////////////////

  bool openEndpoint(Endpoint* endpoint);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief handle request directly
  //////////////////////////////////////////////////////////////////////////////

  void handleRequestDirectly(HttpCommTask* task, HttpHandler* handler);

  //////////////////////////////////////////////////////////////////////////////
  /// @brief registers a task
  //////////////////////////////////////////////////////////////////////////////

  void registerHandler(HttpHandler* handler, HttpCommTask* task);

 protected:
  //////////////////////////////////////////////////////////////////////////////
  /// @brief the scheduler
  //////////////////////////////////////////////////////////////////////////////

  Scheduler* _scheduler;  // TODO (fc) XXX make this a singleton

  //////////////////////////////////////////////////////////////////////////////
  /// @brief the dispatcher
  //////////////////////////////////////////////////////////////////////////////

  Dispatcher* _dispatcher;  // TODO (fc) XXX make this a singleton

  //////////////////////////////////////////////////////////////////////////////
  /// @brief the handler factory
  //////////////////////////////////////////////////////////////////////////////

  HttpHandlerFactory* _handlerFactory;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief the job manager
  //////////////////////////////////////////////////////////////////////////////

  AsyncJobManager* _jobManager;  // TODO (fc) XXX make this a singleton

  //////////////////////////////////////////////////////////////////////////////
  /// @brief active listen tasks
  //////////////////////////////////////////////////////////////////////////////

  std::vector<ListenTask*> _listenTasks;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief defined ports and addresses
  //////////////////////////////////////////////////////////////////////////////

  const EndpointList* _endpointList;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief mutex for comm tasks
  //////////////////////////////////////////////////////////////////////////////

  arangodb::Mutex _commTasksLock;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief active comm tasks
  //////////////////////////////////////////////////////////////////////////////

  std::unordered_set<HttpCommTask*> _commTasks;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief keep-alive timeout
  //////////////////////////////////////////////////////////////////////////////

  double _keepAliveTimeout;
};
}
}

#endif