HTTP Client library

Dependents:   weather_LCD_display News_LCD_display TwitterExample_1 GeoLocation_LCD_Display ... more

Committer:
donatien
Date:
Thu Aug 05 15:09:46 2010 +0000
Revision:
5:d0be6af2d1db
Parent:
0:a828ace1f38d

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:a828ace1f38d 1
donatien 0:a828ace1f38d 2 /*
donatien 0:a828ace1f38d 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
donatien 0:a828ace1f38d 4
donatien 0:a828ace1f38d 5 Permission is hereby granted, free of charge, to any person obtaining a copy
donatien 0:a828ace1f38d 6 of this software and associated documentation files (the "Software"), to deal
donatien 0:a828ace1f38d 7 in the Software without restriction, including without limitation the rights
donatien 0:a828ace1f38d 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
donatien 0:a828ace1f38d 9 copies of the Software, and to permit persons to whom the Software is
donatien 0:a828ace1f38d 10 furnished to do so, subject to the following conditions:
donatien 0:a828ace1f38d 11
donatien 0:a828ace1f38d 12 The above copyright notice and this permission notice shall be included in
donatien 0:a828ace1f38d 13 all copies or substantial portions of the Software.
donatien 0:a828ace1f38d 14
donatien 0:a828ace1f38d 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
donatien 0:a828ace1f38d 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
donatien 0:a828ace1f38d 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
donatien 0:a828ace1f38d 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
donatien 0:a828ace1f38d 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:a828ace1f38d 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
donatien 0:a828ace1f38d 21 THE SOFTWARE.
donatien 0:a828ace1f38d 22 */
donatien 0:a828ace1f38d 23
donatien 5:d0be6af2d1db 24 /** \file
donatien 5:d0be6af2d1db 25 HTTP Client header file
donatien 5:d0be6af2d1db 26 */
donatien 5:d0be6af2d1db 27
donatien 0:a828ace1f38d 28 #ifndef HTTP_CLIENT_H
donatien 0:a828ace1f38d 29 #define HTTP_CLIENT_H
donatien 0:a828ace1f38d 30
donatien 0:a828ace1f38d 31 class HTTPData;
donatien 0:a828ace1f38d 32
donatien 5:d0be6af2d1db 33 #include "core/net.h"
donatien 0:a828ace1f38d 34 #include "api/TCPSocket.h"
donatien 0:a828ace1f38d 35 #include "api/DNSRequest.h"
donatien 0:a828ace1f38d 36 #include "HTTPData.h"
donatien 0:a828ace1f38d 37 #include "mbed.h"
donatien 0:a828ace1f38d 38
donatien 0:a828ace1f38d 39 #include <string>
donatien 0:a828ace1f38d 40 using std::string;
donatien 0:a828ace1f38d 41
donatien 0:a828ace1f38d 42 #include <map>
donatien 0:a828ace1f38d 43 using std::map;
donatien 0:a828ace1f38d 44
donatien 5:d0be6af2d1db 45 ///HTTP client results
donatien 0:a828ace1f38d 46 enum HTTPResult
donatien 0:a828ace1f38d 47 {
donatien 5:d0be6af2d1db 48 HTTP_OK, ///<Success
donatien 5:d0be6af2d1db 49 HTTP_PROCESSING, ///<Processing
donatien 5:d0be6af2d1db 50 HTTP_PARSE, ///<URI Parse error
donatien 5:d0be6af2d1db 51 HTTP_DNS, ///<Could not resolve name
donatien 5:d0be6af2d1db 52 HTTP_PRTCL, ///<Protocol error
donatien 5:d0be6af2d1db 53 HTTP_NOTFOUND, ///<HTTP 404 Error
donatien 5:d0be6af2d1db 54 HTTP_REFUSED, ///<HTTP 403 Error
donatien 5:d0be6af2d1db 55 HTTP_ERROR, ///<HTTP xxx error
donatien 5:d0be6af2d1db 56 HTTP_TIMEOUT, ///<Connection timeout
donatien 5:d0be6af2d1db 57 HTTP_CONN ///<Connection error
donatien 0:a828ace1f38d 58 };
donatien 0:a828ace1f38d 59
donatien 5:d0be6af2d1db 60 #include "core/netservice.h"
donatien 0:a828ace1f38d 61
donatien 5:d0be6af2d1db 62 ///A simple HTTP Client
donatien 5:d0be6af2d1db 63 /**
donatien 5:d0be6af2d1db 64 The HTTPClient is composed of:
donatien 5:d0be6af2d1db 65 - The actual client (HTTPClient)
donatien 5:d0be6af2d1db 66 - Classes that act as a data repository, each of which deriving from the HTTPData class (HTTPText for short text content, HTTPFile for file I/O, HTTPMap for key/value pairs, and HTTPStream for streaming purposes)
donatien 5:d0be6af2d1db 67 */
donatien 0:a828ace1f38d 68 class HTTPClient : protected NetService
donatien 0:a828ace1f38d 69 {
donatien 0:a828ace1f38d 70 public:
donatien 5:d0be6af2d1db 71 ///Instantiates the HTTP client
donatien 0:a828ace1f38d 72 HTTPClient();
donatien 0:a828ace1f38d 73 virtual ~HTTPClient();
donatien 0:a828ace1f38d 74
donatien 5:d0be6af2d1db 75 ///Provides a basic authentification feature (Base64 encoded username and password)
donatien 0:a828ace1f38d 76 void basicAuth(const char* user, const char* password); //Basic Authentification
donatien 0:a828ace1f38d 77
donatien 0:a828ace1f38d 78 //High Level setup functions
donatien 5:d0be6af2d1db 79 ///Executes a GET Request (blocking)
donatien 5:d0be6af2d1db 80 /**
donatien 5:d0be6af2d1db 81 Executes a GET request on the URI uri
donatien 5:d0be6af2d1db 82 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 83 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 84 Blocks until completion
donatien 5:d0be6af2d1db 85 */
donatien 0:a828ace1f38d 86 HTTPResult get(const char* uri, HTTPData* pDataIn); //Blocking
donatien 5:d0be6af2d1db 87
donatien 5:d0be6af2d1db 88 ///Executes a GET Request (non blocking)
donatien 5:d0be6af2d1db 89 /**
donatien 5:d0be6af2d1db 90 Executes a GET request on the URI uri
donatien 5:d0be6af2d1db 91 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 92 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 93 @param pMethod : callback function
donatien 5:d0be6af2d1db 94 The function returns immediately and calls the callback on completion or error
donatien 5:d0be6af2d1db 95 */
donatien 0:a828ace1f38d 96 HTTPResult get(const char* uri, HTTPData* pDataIn, void (*pMethod)(HTTPResult)); //Non blocking
donatien 5:d0be6af2d1db 97
donatien 5:d0be6af2d1db 98 ///Executes a GET Request (non blocking)
donatien 5:d0be6af2d1db 99 /**
donatien 5:d0be6af2d1db 100 Executes a GET request on the URI uri
donatien 5:d0be6af2d1db 101 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 102 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 103 @param pItem : instance of class on which to execute the callback method
donatien 5:d0be6af2d1db 104 @param pMethod : callback method
donatien 5:d0be6af2d1db 105 The function returns immediately and calls the callback on completion or error
donatien 5:d0be6af2d1db 106 */
donatien 0:a828ace1f38d 107 template<class T>
donatien 0:a828ace1f38d 108 HTTPResult get(const char* uri, HTTPData* pDataIn, T* pItem, void (T::*pMethod)(HTTPResult)) //Non blocking
donatien 0:a828ace1f38d 109 {
donatien 0:a828ace1f38d 110 setOnResult(pItem, pMethod);
donatien 0:a828ace1f38d 111 doGet(uri, pDataIn);
donatien 0:a828ace1f38d 112 return HTTP_PROCESSING;
donatien 0:a828ace1f38d 113 }
donatien 0:a828ace1f38d 114
donatien 5:d0be6af2d1db 115 ///Executes a POST Request (blocking)
donatien 5:d0be6af2d1db 116 /**
donatien 5:d0be6af2d1db 117 Executes a POST request on the URI uri
donatien 5:d0be6af2d1db 118 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 119 @param dataOut : a HTTPData instance that contains the data that will be posted
donatien 5:d0be6af2d1db 120 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 121 Blocks until completion
donatien 5:d0be6af2d1db 122 */
donatien 0:a828ace1f38d 123 HTTPResult post(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn); //Blocking
donatien 5:d0be6af2d1db 124
donatien 5:d0be6af2d1db 125 ///Executes a POST Request (non blocking)
donatien 5:d0be6af2d1db 126 /**
donatien 5:d0be6af2d1db 127 Executes a POST request on the URI uri
donatien 5:d0be6af2d1db 128 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 129 @param dataOut : a HTTPData instance that contains the data that will be posted
donatien 5:d0be6af2d1db 130 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 131 @param pMethod : callback function
donatien 5:d0be6af2d1db 132 The function returns immediately and calls the callback on completion or error
donatien 5:d0be6af2d1db 133 */
donatien 0:a828ace1f38d 134 HTTPResult post(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn, void (*pMethod)(HTTPResult)); //Non blocking
donatien 5:d0be6af2d1db 135
donatien 5:d0be6af2d1db 136 ///Executes a POST Request (non blocking)
donatien 5:d0be6af2d1db 137 /**
donatien 5:d0be6af2d1db 138 Executes a POST request on the URI uri
donatien 5:d0be6af2d1db 139 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 140 @param dataOut : a HTTPData instance that contains the data that will be posted
donatien 5:d0be6af2d1db 141 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 142 @param pItem : instance of class on which to execute the callback method
donatien 5:d0be6af2d1db 143 @param pMethod : callback method
donatien 5:d0be6af2d1db 144 The function returns immediately and calls the callback on completion or error
donatien 5:d0be6af2d1db 145 */
donatien 0:a828ace1f38d 146 template<class T>
donatien 0:a828ace1f38d 147 HTTPResult post(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn, T* pItem, void (T::*pMethod)(HTTPResult)) //Non blocking
donatien 0:a828ace1f38d 148 {
donatien 0:a828ace1f38d 149 setOnResult(pItem, pMethod);
donatien 0:a828ace1f38d 150 doPost(uri, dataOut, pDataIn);
donatien 0:a828ace1f38d 151 return HTTP_PROCESSING;
donatien 0:a828ace1f38d 152 }
donatien 5:d0be6af2d1db 153
donatien 5:d0be6af2d1db 154 ///Executes a GET Request (non blocking)
donatien 5:d0be6af2d1db 155 /**
donatien 5:d0be6af2d1db 156 Executes a GET request on the URI uri
donatien 5:d0be6af2d1db 157 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 158 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 159 The function returns immediately and calls the previously set callback on completion or error
donatien 5:d0be6af2d1db 160 */
donatien 5:d0be6af2d1db 161 void doGet(const char* uri, HTTPData* pDataIn);
donatien 0:a828ace1f38d 162
donatien 5:d0be6af2d1db 163 ///Executes a POST Request (non blocking)
donatien 5:d0be6af2d1db 164 /**
donatien 5:d0be6af2d1db 165 Executes a POST request on the URI uri
donatien 5:d0be6af2d1db 166 @param uri : URI on which to execute the request
donatien 5:d0be6af2d1db 167 @param dataOut : a HTTPData instance that contains the data that will be posted
donatien 5:d0be6af2d1db 168 @param pDataIn : pointer to an HTTPData instance that will collect the data returned by the request, can be NULL
donatien 5:d0be6af2d1db 169 @param pMethod : callback function
donatien 5:d0be6af2d1db 170 The function returns immediately and calls the previously set callback on completion or error
donatien 5:d0be6af2d1db 171 */
donatien 0:a828ace1f38d 172 void doPost(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn);
donatien 0:a828ace1f38d 173
donatien 5:d0be6af2d1db 174 ///Setups the result callback
donatien 5:d0be6af2d1db 175 /**
donatien 5:d0be6af2d1db 176 @param pMethod : callback function
donatien 5:d0be6af2d1db 177 */
donatien 0:a828ace1f38d 178 void setOnResult( void (*pMethod)(HTTPResult) );
donatien 5:d0be6af2d1db 179
donatien 5:d0be6af2d1db 180 ///Setups the result callback
donatien 5:d0be6af2d1db 181 /**
donatien 5:d0be6af2d1db 182 @param pItem : instance of class on which to execute the callback method
donatien 5:d0be6af2d1db 183 @param pMethod : callback method
donatien 5:d0be6af2d1db 184 */
donatien 0:a828ace1f38d 185 class CDummy;
donatien 0:a828ace1f38d 186 template<class T>
donatien 0:a828ace1f38d 187 void setOnResult( T* pItem, void (T::*pMethod)(HTTPResult) )
donatien 0:a828ace1f38d 188 {
donatien 0:a828ace1f38d 189 m_pCb = NULL;
donatien 0:a828ace1f38d 190 m_pCbItem = (CDummy*) pItem;
donatien 0:a828ace1f38d 191 m_pCbMeth = (void (CDummy::*)(HTTPResult)) pMethod;
donatien 0:a828ace1f38d 192 }
donatien 5:d0be6af2d1db 193
donatien 5:d0be6af2d1db 194 ///Setups timeout
donatien 5:d0be6af2d1db 195 /**
donatien 5:d0be6af2d1db 196 @param ms : time of connection inactivity in ms after which the request should timeout
donatien 5:d0be6af2d1db 197 */
donatien 0:a828ace1f38d 198 void setTimeout(int ms);
donatien 0:a828ace1f38d 199
donatien 0:a828ace1f38d 200 virtual void poll(); //Called by NetServices
donatien 0:a828ace1f38d 201
donatien 5:d0be6af2d1db 202 ///Gets last request's HTTP response code
donatien 5:d0be6af2d1db 203 /**
donatien 5:d0be6af2d1db 204 @return The HTTP response code of the last request
donatien 5:d0be6af2d1db 205 */
donatien 0:a828ace1f38d 206 int getHTTPResponseCode();
donatien 5:d0be6af2d1db 207
donatien 5:d0be6af2d1db 208 ///Sets a specific request header
donatien 0:a828ace1f38d 209 void setRequestHeader(const string& header, const string& value);
donatien 5:d0be6af2d1db 210
donatien 5:d0be6af2d1db 211 ///Gets a response header
donatien 0:a828ace1f38d 212 string& getResponseHeader(const string& header);
donatien 5:d0be6af2d1db 213
donatien 5:d0be6af2d1db 214 ///Clears request headers
donatien 0:a828ace1f38d 215 void resetRequestHeaders();
donatien 0:a828ace1f38d 216
donatien 0:a828ace1f38d 217 protected:
donatien 0:a828ace1f38d 218 void resetTimeout();
donatien 0:a828ace1f38d 219
donatien 0:a828ace1f38d 220 void init();
donatien 0:a828ace1f38d 221 void close();
donatien 0:a828ace1f38d 222
donatien 0:a828ace1f38d 223 void setup(const char* uri, HTTPData* pDataOut, HTTPData* pDataIn); //Setup request, make DNS Req if necessary
donatien 0:a828ace1f38d 224 void connect(); //Start Connection
donatien 0:a828ace1f38d 225
donatien 0:a828ace1f38d 226 int tryRead(); //Read data and try to feed output
donatien 0:a828ace1f38d 227 void readData(); //Data has been read
donatien 0:a828ace1f38d 228 void writeData(); //Data has been written & buf is free
donatien 0:a828ace1f38d 229
donatien 0:a828ace1f38d 230 void onTCPSocketEvent(TCPSocketEvent e);
donatien 0:a828ace1f38d 231 void onDNSReply(DNSReply r);
donatien 0:a828ace1f38d 232 void onResult(HTTPResult r); //Called when exchange completed or on failure
donatien 0:a828ace1f38d 233 void onTimeout(); //Connection has timed out
donatien 0:a828ace1f38d 234
donatien 0:a828ace1f38d 235 private:
donatien 0:a828ace1f38d 236 HTTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available
donatien 0:a828ace1f38d 237
donatien 0:a828ace1f38d 238 bool readHeaders(); //Called first when receiving data
donatien 0:a828ace1f38d 239 bool writeHeaders(); //Called to create req
donatien 0:a828ace1f38d 240 int readLine(char* str, int maxLen, bool* pIncomplete = NULL);
donatien 0:a828ace1f38d 241
donatien 0:a828ace1f38d 242 enum HTTP_METH
donatien 0:a828ace1f38d 243 {
donatien 0:a828ace1f38d 244 HTTP_GET,
donatien 0:a828ace1f38d 245 HTTP_POST,
donatien 0:a828ace1f38d 246 HTTP_HEAD
donatien 0:a828ace1f38d 247 };
donatien 0:a828ace1f38d 248
donatien 0:a828ace1f38d 249 HTTP_METH m_meth;
donatien 0:a828ace1f38d 250
donatien 0:a828ace1f38d 251 CDummy* m_pCbItem;
donatien 0:a828ace1f38d 252 void (CDummy::*m_pCbMeth)(HTTPResult);
donatien 0:a828ace1f38d 253
donatien 0:a828ace1f38d 254 void (*m_pCb)(HTTPResult);
donatien 0:a828ace1f38d 255
donatien 0:a828ace1f38d 256 TCPSocket* m_pTCPSocket;
donatien 0:a828ace1f38d 257 map<string, string> m_reqHeaders;
donatien 0:a828ace1f38d 258 map<string, string> m_respHeaders;
donatien 0:a828ace1f38d 259
donatien 0:a828ace1f38d 260 Timer m_watchdog;
donatien 0:a828ace1f38d 261 int m_timeout;
donatien 0:a828ace1f38d 262
donatien 0:a828ace1f38d 263 DNSRequest* m_pDnsReq;
donatien 0:a828ace1f38d 264
donatien 0:a828ace1f38d 265 Host m_server;
donatien 0:a828ace1f38d 266 string m_path;
donatien 0:a828ace1f38d 267
donatien 0:a828ace1f38d 268 bool m_closed;
donatien 0:a828ace1f38d 269
donatien 0:a828ace1f38d 270 enum HTTPStep
donatien 0:a828ace1f38d 271 {
donatien 0:a828ace1f38d 272 // HTTP_INIT,
donatien 0:a828ace1f38d 273 HTTP_WRITE_HEADERS,
donatien 0:a828ace1f38d 274 HTTP_WRITE_DATA,
donatien 0:a828ace1f38d 275 HTTP_READ_HEADERS,
donatien 0:a828ace1f38d 276 HTTP_READ_DATA,
donatien 0:a828ace1f38d 277 HTTP_READ_DATA_INCOMPLETE,
donatien 0:a828ace1f38d 278 HTTP_DONE,
donatien 0:a828ace1f38d 279 HTTP_CLOSED
donatien 0:a828ace1f38d 280 };
donatien 0:a828ace1f38d 281
donatien 0:a828ace1f38d 282 HTTPStep m_state;
donatien 0:a828ace1f38d 283
donatien 0:a828ace1f38d 284 HTTPData* m_pDataOut;
donatien 0:a828ace1f38d 285 HTTPData* m_pDataIn;
donatien 0:a828ace1f38d 286
donatien 0:a828ace1f38d 287 bool m_dataChunked; //Data is encoded as chunks
donatien 0:a828ace1f38d 288 int m_dataPos; //Position in data
donatien 0:a828ace1f38d 289 int m_dataLen; //Data length
donatien 0:a828ace1f38d 290 char* m_buf;
donatien 0:a828ace1f38d 291 char* m_pBufRemaining; //Remaining
donatien 0:a828ace1f38d 292 int m_bufRemainingLen; //Data length in m_pBufRemaining
donatien 0:a828ace1f38d 293
donatien 0:a828ace1f38d 294 int m_httpResponseCode;
donatien 0:a828ace1f38d 295
donatien 0:a828ace1f38d 296 HTTPResult m_blockingResult; //Result if blocking mode
donatien 0:a828ace1f38d 297
donatien 0:a828ace1f38d 298 };
donatien 0:a828ace1f38d 299
donatien 0:a828ace1f38d 300 //Including data containers here for more convenience
donatien 0:a828ace1f38d 301 #include "data/HTTPFile.h"
donatien 0:a828ace1f38d 302 #include "data/HTTPStream.h"
donatien 0:a828ace1f38d 303 #include "data/HTTPText.h"
donatien 0:a828ace1f38d 304 #include "data/HTTPMap.h"
donatien 0:a828ace1f38d 305
donatien 0:a828ace1f38d 306 #endif