2143f6eeb1441b1d3e0af5e9432c9bd3208eb858
[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    * Destructor.
46    */
47   virtual ~Transport() {;}
48
49   /**
50      Devuelve la longitud del cuerpo del mensaje asociado.
51      \return la longitud del cuerpo del mensaje asociado.
52      \warning Exclusivamente de uso interno.
53   */
54   int getContentLength() const throw() { return a_contentLength; }
55
56   /**
57      Devuelve el mensaje de entrada asociado.
58      \return La instancia del mensaje de entrada asociado.
59      \warning Exclusivamente de uso interno.
60   */
61   http::Message* getInputMessage() throw(RuntimeException);
62
63   /**
64      Establece la longitud del cuerpo del mensaje asociado.
65      \param contentLength Longitud del cuerpo del mensaje asociado.
66      \warning Exclusivamente de uso interno.
67   */
68   void setContentLength(const int contentLength) throw(RuntimeException) { a_contentLength = contentLength; }
69
70   /**
71      Establece la posicion donde comienza el cuerpo del mensaje asociado.
72      \param bodyOffset Posicion donde comienza el cuerpor del mensaje.
73      \warning Exclusivamente de uso interno.
74   */
75   void setBodyOffset(const int bodyOffset) throw(RuntimeException) { a_bodyOffset = bodyOffset; }
76
77   /**
78      Metodo que inicializa el estado de esta capa de transporte. Se invoca
79      directamente por el nucleo cuando sea necesario.
80   */
81   void clear() throw();
82
83   /**
84    * Permite obtener una instancia de anna::http::Message correspondiente al búfer recibido como parámetro.
85    * \param buffer Espacio de memoria que contiene el mensaje HTTP a interpretar.
86    * \param length Longitud del búfer.
87    * \Warning Al ser invocado desde el exterior de la plataforma no hay ninguna sección crítica que la
88    * proteja, porque lo que si se invoca en modo MT desde varios thread habrá que establecer las secciones
89    * críticas necesarias para que sólo un thread pueda acceder a este método.
90    */
91   const http::Message* externalDecode(const char* buffer, const int length) throw(RuntimeException);
92
93   /**
94      Instancia un mensaje HTTP de entrada del tipo determinado por \em type.
95      \param type Tipo de mensaje HTTP detectado en la entrada.
96      \return La instancia del mensaje creado.
97      \internal
98   */
99   http::Message* allocateInputMessage(const Message::Type::_v type) throw(RuntimeException);
100
101   /**
102    * Devuelve el bloque de datos codificados asociados a esta instancia.
103    * \warning Exclusivamente uso interno.
104    */
105   EncodedBlock* getEncodedBlock() throw();
106
107   /**
108      Separa el token recibido como parametro en distintos componentes basicos, usando
109      como separadores los caracteres de espacios, tabs, etc.
110
111      \param token Token sobre el que deseamos aplicar la separacion.
112
113      \return Una instancia del Tokenizer con el que poder recorrer todos los componentes.
114   */
115   const Tokenizer& split(const Token& token) throw(RuntimeException);
116
117   /**
118      Separa el token recibido como parametro en distintos componentes basicos.
119
120      \param token Token sobre el que deseamos aplicar la separacion.
121      \param separator Separador usado para detectar los tokens. No puede ser NULL:
122
123      \return Una instancia del Tokenizer con el que poder recorrer todos los componentes.
124   */
125   const Tokenizer& split(const Token& token, const char* separator) throw(RuntimeException);
126
127   /**
128      Separa el token recibido como parametro en distintos componentes basicos.
129
130      \param token Token sobre el que deseamos aplicar la separacion.
131      \param separator Separador usado para detectar los tokens.
132
133      \return Una instancia del Tokenizer con el que poder recorrer todos los componentes.
134   */
135   const Tokenizer& split(const Token& token, const char separator) throw(RuntimeException);
136
137   /**
138      Devuelve el literal que identifica de esta clase.
139      \return el literal que identifica de esta clase.
140   */
141   static const char* className() throw() { return "anna::http::Transport"; }
142
143   /**
144      Devuelve el gestor de capas de transporte asociado a esta clase.
145      \return El gestor de capas de transporte asociado a esta clase.
146   */
147   static comm::TransportFactory& getFactory() throw() { return st_factory; }
148
149 private:
150   //-------------------------------------------------------------------------------------
151   // - a_parser: Analizador del mensaje HTTP. Realiza un analisis en profundidad para
152   // interpretar el contenido del mensaje.
153   // - a_contentLenth: Tamaño indicado por la etiqueta HTTP Content-length.
154   // - a_bodyOffset: Indica el desplazamiento que hay que aplicar en http::Transport::decode
155   // para direccionar el contenido del mensaje HTTP.
156   // - a_result: El decode nos obliga a devolver un DataBlock => devolvemos el
157   // a_inputMessage que nos dara la direccion al http::Message al invocar a
158   // DataBlock::getData.
159   // - a_haveToClear: Indica si el metodo calculeSize debe iniciar el estado de la instancia.
160   // - a_inputMessage: Instancia del mensaje obtenida al realizar el analisis detallado
161   // del ultimo mensaje recibido.
162   //--------------------------------------------------------------------------------------
163   const parser::Abstract* a_parser;
164   int a_contentLength;
165   int a_bodyOffset;
166   DataBlock a_result;
167   bool a_haveToClear;
168   http::Message* a_inputMessage;
169   Tokenizer a_fullScope;
170   Tokenizer a_lineScope;
171   EncodedBlock* a_encodedBlock;
172   int a_lastChunkedByte;
173   const DataBlock* a_fullMessage;
174
175   static comm::TransportFactoryImpl <http::Transport> st_factory;
176
177   void setParserState(const parser::Abstract* parser) throw(RuntimeException);
178
179   int calculeSize(const DataBlock&) throw(RuntimeException);
180   const comm::Message* decode(const DataBlock&) throw(RuntimeException);
181   const DataBlock& code(comm::Message&) throw(RuntimeException);
182
183   /*
184      static const Token* tryRequest (const Tokenizer&) throw ();
185      static const Token* tryResponse (const Tokenizer&) throw ();
186   */
187   friend class anna::Allocator <http::Transport>;
188   friend class parser::Abstract;
189 };
190
191 }
192 }
193 #endif
194