include/anna/http/http.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_http_hpp
  38 #define anna_http_http_hpp
  39
  40 namespace anna {
  41
  42 /**
  43    Proporciona los componentes necesarios para la comunicacion entre procesos usando como
  44    capa de transporte el protocolo HTTP 1.1 definido en el RFC 2616.
  45
  46    A continacion mostramos la forma en la que se podria definir un ServerSocket que atiende peticiones y/o respuesta
  47    sobre el protocolo HTTP.
  48
  49    \code
  50    void MyHTTPServer::initialize ()
  51       throw (RuntimeException)
  52    {
  53       CommandLine& cl (CommandLine::instantiate ());
  54
  55       int port = cl.getIntegerValue ("p");
  56       const comm::Device* device = Network::instantiate ().find (Device::asAddress (cl.getValue ("a")));
  57
  58       a_serverSocket = new ServerSocket (INetAddress (device, port), cl.exists ("r"), &anna::http::Transport::getFactory ());
  59    }
  60    \endcode
  61
  62    El siguiente ejemplo muestra como podriamos definir un cliente HTTP que realiza las peticiones sobre un servidor
  63    HTTP:
  64
  65    \code
  66    void MyHTTPClient::initialize ()
  67       throw (RuntimeException)
  68    {
  69       CommandLine& cl (CommandLine::instantiate ());
  70
  71       Network& network = Network::instantiate ();
  72
  73       Host* host = network.find ("host000");
  74       host->assign (network.find (Device::asAddress (cl.getValue ("a"))));
  75       a_server = host->createServer ("http_server", cl.getIntegerValue ("p"), true, &anna::http::Transport::getFactory ());
  76    }
  77    \endcode
  78
  79    El ejecutable debera enlazarse con las librerias:
  80       \li libanna.core.a
  81       \li libanna.xml.a
  82       \li libanna.app.a
  83       \li libanna.comm.a
  84       \li libanna.http.a
  85
  86    El <b>Packet Header</b> es anna.http.h
  87 */
  88 namespace http {
  89 }
  90
  91 }
  92
  93 #include <anna.http.functions.h>
  94 #include <anna.http.Handler.h>
  95 #include <anna.http.Header.h>
  96 #include <anna.http.MessageFactory.h>
  97 #include <anna.http.Message.h>
  98 #include <anna.http.Method.h>
  99 #include <anna.http.Request.h>
 100 #include <anna.http.Response.h>
 101 #include <anna.http.Transport.h>
 102
 103 using namespace anna::http;
 104
 105 #endif
 106