include/anna/http/Handler.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_http_Handler_hpp
  38 #define anna_http_Handler_hpp
  39
  40 #include <anna/core/mt/Mutex.hpp>
  41
  42 #include <anna/comm/Receiver.hpp>
  43
  44 namespace anna {
  45
  46 class DataBlock;
  47
  48 namespace comm {
  49 class ClientSocket;
  50 class Message;
  51 }
  52
  53 namespace http {
  54
  55 class Request;
  56 class Response;
  57
  58 /**
  59    Manejador de Respuestas y/o peticiones sobre protocolo HTTP.
  60 */
  61 class Handler : public comm::Receiver {
  62 public:
  63   /**
  64      Destructor.
  65   */
  66   virtual ~Handler();
  67
  68   /**
  69      Trata la informacion contenida en el mensaje recibido. Si el mensaje recibido es un mensaje HTTP
  70      valido se terminara llamando a uno de los metodos manejadores evRequest o evResponse, dependiendo
  71      del tipo de mensaje.
  72
  73      \param clientSocket Socket por el que se recibe la peticion, y por el que podriamos enviar la respuesta
  74      en caso de ser necesario.
  75      \param message Mensaje HTTP recibido.
  76   */
  77   void apply(comm::ClientSocket& clientSocket, const comm::Message& message) throw(RuntimeException);
  78
  79 protected:
  80   /**
  81      Constructor.
  82      \param name Nombre logico de este manejador.
  83   */
  84   Handler(const char* name) : comm::Receiver(name), a_response(NULL) {;}
  85
  86   /**
  87      Devuelve una instancia de http::Response que puede ser usada para responser a una peticion.
  88      \return una instancia de http::Response que puede ser usada para responser a una peticion.
  89   */
  90   Response* allocateResponse() throw();
  91
  92   /**
  93      Metodo virtual que debemos sobreescribir para tratar las peticiones HTTP.
  94      \param clientSocket Socket por el que se recibe la peticion, y por el que podriamos enviar la respuesta
  95      en caso de ser necesario.
  96      \param request Peticion HTTP a tratar.
  97   */
  98   virtual void evRequest(comm::ClientSocket& clientSocket, const Request& request) throw(RuntimeException) = 0;
  99
 100   /**
 101      Metodo virtual que debemos sobreescribir para tratar las respuestas HTTP.
 102      \param clientSocket Socket por el que se recibe la respuesta.
 103      \param response respuesta HTTP a tratar.
 104   */
 105   virtual void evResponse(comm::ClientSocket& clientSocket, const Response& response) throw(RuntimeException) = 0;
 106
 107 private:
 108   Response* a_response;
 109 };
 110
 111 }
 112 }
 113
 114 #endif
 115