673d3a14c2f7f5a48da14e7a006d7202a97bb2b6
[anna.git] / include / anna / http / Transport.hpp
1 // ANNA - Anna is Not Nothingness Anymore                                                         //
2 //                                                                                                //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
4 //                                                                                                //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
7
8
9 #ifndef anna_http_Transport_hpp
10 #define anna_http_Transport_hpp
11
12 #include <anna/core/DataBlock.hpp>
13
14 #include <anna/comm/Transport.hpp>
15 #include <anna/comm/TransportFactory.hpp>
16 #include <anna/comm/TransportFactoryImpl.hpp>
17
18 #include <anna/http/internal/Tokenizer.hpp>
19 #include <anna/http/Message.hpp>
20
21 namespace anna {
22
23 namespace http {
24
25 class EncodedBlock;
26
27 namespace parser {
28 class Abstract;
29 }
30
31 /**
32    Clase generica para definir la capa de transporte del protocolo HTTP.
33
34    \see Transport.
35 */
36 class Transport : public comm::Transport {
37 public:
38   /**
39    * Constructor.
40    * Sólo debería usarse en caso de tener que usar el método #externalDecode.
41    */
42   Transport();
43
44   /**
45      Devuelve la longitud del cuerpo del mensaje asociado.
46      \return la longitud del cuerpo del mensaje asociado.
47      \warning Exclusivamente de uso interno.
48   */
49   int getContentLength() const throw() { return a_contentLength; }
50
51   /**
52      Devuelve el mensaje de entrada asociado.
53      \return La instancia del mensaje de entrada asociado.
54      \warning Exclusivamente de uso interno.
55   */
56   http::Message* getInputMessage() throw(RuntimeException);
57
58   /**
59      Establece la longitud del cuerpo del mensaje asociado.
60      \param contentLength Longitud del cuerpo del mensaje asociado.
61      \warning Exclusivamente de uso interno.
62   */
63   void setContentLength(const int contentLength) throw(RuntimeException) { a_contentLength = contentLength; }
64
65   /**
66      Establece la posicion donde comienza el cuerpo del mensaje asociado.
67      \param bodyOffset Posicion donde comienza el cuerpor del mensaje.
68      \warning Exclusivamente de uso interno.
69   */
70   void setBodyOffset(const int bodyOffset) throw(RuntimeException) { a_bodyOffset = bodyOffset; }
71
72   /**
73      Metodo que inicializa el estado de esta capa de transporte. Se invoca
74      directamente por el nucleo cuando sea necesario.
75   */
76   void clear() throw();
77
78   /**
79    * Permite obtener una instancia de anna::http::Message correspondiente al búfer recibido como parámetro.
80    * \param buffer Espacio de memoria que contiene el mensaje HTTP a interpretar.
81    * \param length Longitud del búfer.
82    * \Warning Al ser invocado desde el exterior de la plataforma no hay ninguna sección crítica que la
83    * proteja, porque lo que si se invoca en modo MT desde varios thread habrá que establecer las secciones
84    * críticas necesarias para que sólo un thread pueda acceder a este método.
85    */
86   const http::Message* externalDecode(const char* buffer, const int length) throw(RuntimeException);
87
88   /**
89      Instancia un mensaje HTTP de entrada del tipo determinado por \em type.
90      \param type Tipo de mensaje HTTP detectado en la entrada.
91      \return La instancia del mensaje creado.
92      \internal
93   */
94   http::Message* allocateInputMessage(const Message::Type::_v type) throw(RuntimeException);
95
96   /**
97    * Devuelve el bloque de datos codificados asociados a esta instancia.
98    * \warning Exclusivamente uso interno.
99    */
100   EncodedBlock* getEncodedBlock() throw();
101
102   /**
103      Separa el token recibido como parametro en distintos componentes basicos, usando
104      como separadores los caracteres de espacios, tabs, etc.
105
106      \param token Token sobre el que deseamos aplicar la separacion.
107
108      \return Una instancia del Tokenizer con el que poder recorrer todos los componentes.
109   */
110   const Tokenizer& split(const Token& token) throw(RuntimeException);
111
112   /**
113      Separa el token recibido como parametro en distintos componentes basicos.
114
115      \param token Token sobre el que deseamos aplicar la separacion.
116      \param separator Separador usado para detectar los tokens. No puede ser NULL:
117
118      \return Una instancia del Tokenizer con el que poder recorrer todos los componentes.
119   */
120   const Tokenizer& split(const Token& token, const char* separator) throw(RuntimeException);
121
122   /**
123      Separa el token recibido como parametro en distintos componentes basicos.
124
125      \param token Token sobre el que deseamos aplicar la separacion.
126      \param separator Separador usado para detectar los tokens.
127
128      \return Una instancia del Tokenizer con el que poder recorrer todos los componentes.
129   */
130   const Tokenizer& split(const Token& token, const char separator) throw(RuntimeException);
131
132   /**
133      Devuelve el literal que identifica de esta clase.
134      \return el literal que identifica de esta clase.
135   */
136   static const char* className() throw() { return "anna::http::Transport"; }
137
138   /**
139      Devuelve el gestor de capas de transporte asociado a esta clase.
140      \return El gestor de capas de transporte asociado a esta clase.
141   */
142   static comm::TransportFactory& getFactory() throw() { return st_factory; }
143
144 private:
145   //-------------------------------------------------------------------------------------
146   // - a_parser: Analizador del mensaje HTTP. Realiza un analisis en profundidad para
147   // interpretar el contenido del mensaje.
148   // - a_contentLenth: Tamaño indicado por la etiqueta HTTP Content-length.
149   // - a_bodyOffset: Indica el desplazamiento que hay que aplicar en http::Transport::decode
150   // para direccionar el contenido del mensaje HTTP.
151   // - a_result: El decode nos obliga a devolver un DataBlock => devolvemos el
152   // a_inputMessage que nos dara la direccion al http::Message al invocar a
153   // DataBlock::getData.
154   // - a_haveToClear: Indica si el metodo calculeSize debe iniciar el estado de la instancia.
155   // - a_inputMessage: Instancia del mensaje obtenida al realizar el analisis detallado
156   // del ultimo mensaje recibido.
157   //--------------------------------------------------------------------------------------
158   const parser::Abstract* a_parser;
159   int a_contentLength;
160   int a_bodyOffset;
161   DataBlock a_result;
162   bool a_haveToClear;
163   http::Message* a_inputMessage;
164   Tokenizer a_fullScope;
165   Tokenizer a_lineScope;
166   EncodedBlock* a_encodedBlock;
167   int a_lastChunkedByte;
168   const DataBlock* a_fullMessage;
169
170   static comm::TransportFactoryImpl <http::Transport> st_factory;
171
172   void setParserState(const parser::Abstract* parser) throw(RuntimeException);
173
174   int calculeSize(const DataBlock&) throw(RuntimeException);
175   const comm::Message* decode(const DataBlock&) throw(RuntimeException);
176   const DataBlock& code(comm::Message&) throw(RuntimeException);
177
178   /*
179      static const Token* tryRequest (const Tokenizer&) throw ();
180      static const Token* tryResponse (const Tokenizer&) throw ();
181   */
182   friend class anna::Allocator <http::Transport>;
183   friend class parser::Abstract;
184 };
185
186 }
187 }
188 #endif
189