include/anna/http/Method.hpp

   1 // ANNA - Anna is Not 'N' 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_Method_hpp
  38 #define anna_http_Method_hpp
  39
  40 #include <string>
  41
  42 #include <anna/config/defines.hpp>
  43 #include <anna/core/define.autoenum.hpp>
  44
  45 namespace anna {
  46
  47 namespace http {
  48
  49 class Token;
  50
  51 /**
  52    Metodos utilizados para realizar peticiones HTTP.
  53 */
  54 class Method {
  55 public:
  56   /**
  57      Tipos de peticiones definidos en la RFC 2616
  58      \see Method
  59   */
  60   struct Type {
  61     enum _v {
  62       None = -1, Post, Options, Get, Head, Put, Delete, Trace, Connect
  63     };
  64     anna_declare_enum(Type);
  65   };
  66
  67   /**
  68      Interpreta el token recibido como parametro y devuelve el valor de Type con el
  69      que esta asociado.
  70      \param token Token obtenido en la fase de analisis.
  71      \warning Exclusivamente uso interno.
  72      \return El tipo de metodo.
  73   */
  74   static Type::_v asType(const Token* token) throw();
  75
  76   /**
  77      Devuelve el nombre del metodo con el que esta asociado el tipo recibido.
  78      \param type Tipo de metodo.
  79      \return el nombre del metodo con el que esta asociado el tipo recibido.
  80   */
  81   static std::string asString(const Type::_v type) throw();
  82
  83 private:
  84   Method() {;}
  85 };
  86
  87
  88 }
  89 }
  90
  91 #endif