Donatien Garnier
Dependents: SimpleLCDClock readCard2Twitter_http AnalogClock_StepperMotor_NTP ServoCamV1
services/http/client/HttpClient.h@2:32345cf67bf2, 2010-05-25 (annotated)
- Committer:
- donatien
- Date:
- Tue May 25 11:58:19 2010 +0000
- Revision:
- 2:32345cf67bf2
- Parent:
- 1:7043cc0db03c
- Child:
- 5:10a866da9722
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 1:7043cc0db03c | 1 | |
| donatien | 1:7043cc0db03c | 2 | /* |
| donatien | 2:32345cf67bf2 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 1:7043cc0db03c | 4 | |
| donatien | 1:7043cc0db03c | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 1:7043cc0db03c | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 1:7043cc0db03c | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 1:7043cc0db03c | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 1:7043cc0db03c | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 1:7043cc0db03c | 10 | furnished to do so, subject to the following conditions: |
| donatien | 1:7043cc0db03c | 11 | |
| donatien | 1:7043cc0db03c | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 1:7043cc0db03c | 13 | all copies or substantial portions of the Software. |
| donatien | 1:7043cc0db03c | 14 | |
| donatien | 1:7043cc0db03c | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 1:7043cc0db03c | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 1:7043cc0db03c | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 1:7043cc0db03c | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 1:7043cc0db03c | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 1:7043cc0db03c | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 1:7043cc0db03c | 21 | THE SOFTWARE. |
| donatien | 1:7043cc0db03c | 22 | */ |
| donatien | 1:7043cc0db03c | 23 | |
| donatien | 0:a2dd0ba6cd2d | 24 | #ifndef HTTP_CLIENT_H |
| donatien | 0:a2dd0ba6cd2d | 25 | #define HTTP_CLIENT_H |
| donatien | 0:a2dd0ba6cd2d | 26 | |
| donatien | 0:a2dd0ba6cd2d | 27 | class HttpData; |
| donatien | 0:a2dd0ba6cd2d | 28 | |
| donatien | 0:a2dd0ba6cd2d | 29 | #include "if/net/net.h" |
| donatien | 0:a2dd0ba6cd2d | 30 | #include "api/TcpSocket.h" |
| donatien | 0:a2dd0ba6cd2d | 31 | #include "api/DnsRequest.h" |
| donatien | 0:a2dd0ba6cd2d | 32 | #include "HttpData.h" |
| donatien | 0:a2dd0ba6cd2d | 33 | #include "mbed.h" |
| donatien | 0:a2dd0ba6cd2d | 34 | |
| donatien | 0:a2dd0ba6cd2d | 35 | #include <string> |
| donatien | 0:a2dd0ba6cd2d | 36 | using std::string; |
| donatien | 0:a2dd0ba6cd2d | 37 | |
| donatien | 0:a2dd0ba6cd2d | 38 | #include <map> |
| donatien | 0:a2dd0ba6cd2d | 39 | using std::map; |
| donatien | 0:a2dd0ba6cd2d | 40 | |
| donatien | 0:a2dd0ba6cd2d | 41 | #define HTTP_REQUEST_TIMEOUT 30000//15000 |
| donatien | 0:a2dd0ba6cd2d | 42 | #define HTTP_PORT 80 |
| donatien | 0:a2dd0ba6cd2d | 43 | |
| donatien | 0:a2dd0ba6cd2d | 44 | enum HttpResult |
| donatien | 0:a2dd0ba6cd2d | 45 | { |
| donatien | 0:a2dd0ba6cd2d | 46 | HTTP_OK, |
| donatien | 0:a2dd0ba6cd2d | 47 | HTTP_PROCESSING, |
| donatien | 0:a2dd0ba6cd2d | 48 | HTTP_PARSE, //URI Parse error |
| donatien | 0:a2dd0ba6cd2d | 49 | HTTP_DNS, //Could not resolve name |
| donatien | 0:a2dd0ba6cd2d | 50 | HTTP_PRTCL, //Protocol error |
| donatien | 0:a2dd0ba6cd2d | 51 | HTTP_NOTFOUND, //404 Error |
| donatien | 0:a2dd0ba6cd2d | 52 | HTTP_REFUSED, //403 Error |
| donatien | 0:a2dd0ba6cd2d | 53 | HTTP_ERROR, //xxx error |
| donatien | 0:a2dd0ba6cd2d | 54 | HTTP_TIMEOUT, //Connection timeout |
| donatien | 0:a2dd0ba6cd2d | 55 | HTTP_CONN //Connection error |
| donatien | 0:a2dd0ba6cd2d | 56 | }; |
| donatien | 0:a2dd0ba6cd2d | 57 | |
| donatien | 0:a2dd0ba6cd2d | 58 | |
| donatien | 0:a2dd0ba6cd2d | 59 | |
| donatien | 0:a2dd0ba6cd2d | 60 | class HttpClient : protected NetService |
| donatien | 0:a2dd0ba6cd2d | 61 | { |
| donatien | 0:a2dd0ba6cd2d | 62 | public: |
| donatien | 0:a2dd0ba6cd2d | 63 | HttpClient(); |
| donatien | 0:a2dd0ba6cd2d | 64 | virtual ~HttpClient(); |
| donatien | 0:a2dd0ba6cd2d | 65 | |
| donatien | 0:a2dd0ba6cd2d | 66 | void basicAuth(const char* user, const char* password); //Basic Authentification |
| donatien | 0:a2dd0ba6cd2d | 67 | |
| donatien | 0:a2dd0ba6cd2d | 68 | //High Level setup functions |
| donatien | 0:a2dd0ba6cd2d | 69 | HttpResult get(const char* uri, HttpData* pDataIn); //Blocking |
| donatien | 0:a2dd0ba6cd2d | 70 | HttpResult get(const char* uri, HttpData* pDataIn, void (*pMethod)(HttpResult)); //Non blocking |
| donatien | 0:a2dd0ba6cd2d | 71 | template<class T> |
| donatien | 0:a2dd0ba6cd2d | 72 | //Linker bug : Must be defined here :( |
| donatien | 0:a2dd0ba6cd2d | 73 | HttpResult get(const char* uri, HttpData* pDataIn, T* pItem, void (T::*pMethod)(HttpResult)) //Non blocking |
| donatien | 0:a2dd0ba6cd2d | 74 | { |
| donatien | 0:a2dd0ba6cd2d | 75 | setOnResult(pItem, pMethod); |
| donatien | 0:a2dd0ba6cd2d | 76 | doGet(uri, pDataIn); |
| donatien | 0:a2dd0ba6cd2d | 77 | return HTTP_PROCESSING; |
| donatien | 0:a2dd0ba6cd2d | 78 | } |
| donatien | 0:a2dd0ba6cd2d | 79 | |
| donatien | 0:a2dd0ba6cd2d | 80 | HttpResult post(const char* uri, const HttpData& dataOut, HttpData* pDataIn); //Blocking |
| donatien | 0:a2dd0ba6cd2d | 81 | HttpResult post(const char* uri, const HttpData& dataOut, HttpData* pDataIn, void (*pMethod)(HttpResult)); //Non blocking |
| donatien | 0:a2dd0ba6cd2d | 82 | template<class T> |
| donatien | 0:a2dd0ba6cd2d | 83 | //Linker bug : Must be defined here :( |
| donatien | 0:a2dd0ba6cd2d | 84 | HttpResult post(const char* uri, const HttpData& dataOut, HttpData* pDataIn, T* pItem, void (T::*pMethod)(HttpResult)) //Non blocking |
| donatien | 0:a2dd0ba6cd2d | 85 | { |
| donatien | 0:a2dd0ba6cd2d | 86 | setOnResult(pItem, pMethod); |
| donatien | 0:a2dd0ba6cd2d | 87 | doPost(uri, dataOut, pDataIn); |
| donatien | 0:a2dd0ba6cd2d | 88 | return HTTP_PROCESSING; |
| donatien | 0:a2dd0ba6cd2d | 89 | } |
| donatien | 0:a2dd0ba6cd2d | 90 | |
| donatien | 0:a2dd0ba6cd2d | 91 | void doGet(const char* uri, HttpData* pDataIn); |
| donatien | 0:a2dd0ba6cd2d | 92 | void doPost(const char* uri, const HttpData& dataOut, HttpData* pDataIn); |
| donatien | 0:a2dd0ba6cd2d | 93 | |
| donatien | 0:a2dd0ba6cd2d | 94 | void setOnResult( void (*pMethod)(HttpResult) ); |
| donatien | 0:a2dd0ba6cd2d | 95 | class CDummy; |
| donatien | 0:a2dd0ba6cd2d | 96 | template<class T> |
| donatien | 0:a2dd0ba6cd2d | 97 | //Linker bug : Must be defined here :( |
| donatien | 0:a2dd0ba6cd2d | 98 | void setOnResult( T* pItem, void (T::*pMethod)(HttpResult) ) |
| donatien | 0:a2dd0ba6cd2d | 99 | { |
| donatien | 0:a2dd0ba6cd2d | 100 | m_pCb = NULL; |
| donatien | 0:a2dd0ba6cd2d | 101 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:a2dd0ba6cd2d | 102 | m_pCbMeth = (void (CDummy::*)(HttpResult)) pMethod; |
| donatien | 0:a2dd0ba6cd2d | 103 | } |
| donatien | 0:a2dd0ba6cd2d | 104 | |
| donatien | 0:a2dd0ba6cd2d | 105 | void setTimeout(int ms); |
| donatien | 0:a2dd0ba6cd2d | 106 | |
| donatien | 0:a2dd0ba6cd2d | 107 | virtual void poll(); //Called by NetServices |
| donatien | 0:a2dd0ba6cd2d | 108 | |
| donatien | 0:a2dd0ba6cd2d | 109 | int getHttpResponseCode(); |
| donatien | 0:a2dd0ba6cd2d | 110 | void setRequestHeader(const string& header, const string& value); |
| donatien | 0:a2dd0ba6cd2d | 111 | string& getResponseHeader(const string& header); |
| donatien | 0:a2dd0ba6cd2d | 112 | void resetRequestHeaders(); |
| donatien | 0:a2dd0ba6cd2d | 113 | |
| donatien | 0:a2dd0ba6cd2d | 114 | protected: |
| donatien | 0:a2dd0ba6cd2d | 115 | void resetTimeout(); |
| donatien | 0:a2dd0ba6cd2d | 116 | |
| donatien | 0:a2dd0ba6cd2d | 117 | void init(); |
| donatien | 0:a2dd0ba6cd2d | 118 | void close(); |
| donatien | 0:a2dd0ba6cd2d | 119 | |
| donatien | 0:a2dd0ba6cd2d | 120 | void setup(const char* uri, HttpData* pDataOut, HttpData* pDataIn); //Setup request, make DNS Req if necessary |
| donatien | 0:a2dd0ba6cd2d | 121 | void connect(); //Start Connection |
| donatien | 0:a2dd0ba6cd2d | 122 | |
| donatien | 0:a2dd0ba6cd2d | 123 | int tryRead(); //Read data and try to feed output |
| donatien | 0:a2dd0ba6cd2d | 124 | void readData(); //Data has been read |
| donatien | 0:a2dd0ba6cd2d | 125 | void writeData(); //Data has been written & buf is free |
| donatien | 0:a2dd0ba6cd2d | 126 | |
| donatien | 0:a2dd0ba6cd2d | 127 | void onTcpSocketEvent(TcpSocketEvent e); |
| donatien | 0:a2dd0ba6cd2d | 128 | void onDnsReply(DnsReply r); |
| donatien | 0:a2dd0ba6cd2d | 129 | void onResult(HttpResult r); //Called when exchange completed or on failure |
| donatien | 0:a2dd0ba6cd2d | 130 | void onTimeout(); //Connection has timed out |
| donatien | 0:a2dd0ba6cd2d | 131 | |
| donatien | 0:a2dd0ba6cd2d | 132 | private: |
| donatien | 0:a2dd0ba6cd2d | 133 | HttpResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available |
| donatien | 0:a2dd0ba6cd2d | 134 | |
| donatien | 0:a2dd0ba6cd2d | 135 | bool readHeaders(); //Called first when receiving data |
| donatien | 0:a2dd0ba6cd2d | 136 | bool writeHeaders(); //Called to create req |
| donatien | 2:32345cf67bf2 | 137 | int readLine(char* str, int maxLen, bool* pIncomplete = NULL); |
| donatien | 0:a2dd0ba6cd2d | 138 | |
| donatien | 0:a2dd0ba6cd2d | 139 | enum HTTP_METH |
| donatien | 0:a2dd0ba6cd2d | 140 | { |
| donatien | 0:a2dd0ba6cd2d | 141 | HTTP_GET, |
| donatien | 0:a2dd0ba6cd2d | 142 | HTTP_POST, |
| donatien | 0:a2dd0ba6cd2d | 143 | HTTP_HEAD |
| donatien | 0:a2dd0ba6cd2d | 144 | }; |
| donatien | 0:a2dd0ba6cd2d | 145 | |
| donatien | 0:a2dd0ba6cd2d | 146 | HTTP_METH m_meth; |
| donatien | 0:a2dd0ba6cd2d | 147 | |
| donatien | 0:a2dd0ba6cd2d | 148 | CDummy* m_pCbItem; |
| donatien | 0:a2dd0ba6cd2d | 149 | void (CDummy::*m_pCbMeth)(HttpResult); |
| donatien | 0:a2dd0ba6cd2d | 150 | |
| donatien | 0:a2dd0ba6cd2d | 151 | void (*m_pCb)(HttpResult); |
| donatien | 0:a2dd0ba6cd2d | 152 | |
| donatien | 0:a2dd0ba6cd2d | 153 | TcpSocket* m_pTcpSocket; |
| donatien | 0:a2dd0ba6cd2d | 154 | map<string, string> m_reqHeaders; |
| donatien | 0:a2dd0ba6cd2d | 155 | map<string, string> m_respHeaders; |
| donatien | 0:a2dd0ba6cd2d | 156 | |
| donatien | 0:a2dd0ba6cd2d | 157 | Timer m_watchdog; |
| donatien | 0:a2dd0ba6cd2d | 158 | int m_timeout; |
| donatien | 0:a2dd0ba6cd2d | 159 | |
| donatien | 0:a2dd0ba6cd2d | 160 | DnsRequest* m_pDnsReq; |
| donatien | 0:a2dd0ba6cd2d | 161 | |
| donatien | 0:a2dd0ba6cd2d | 162 | Host m_server; |
| donatien | 0:a2dd0ba6cd2d | 163 | string m_path; |
| donatien | 0:a2dd0ba6cd2d | 164 | |
| donatien | 0:a2dd0ba6cd2d | 165 | bool m_closed; |
| donatien | 0:a2dd0ba6cd2d | 166 | |
| donatien | 0:a2dd0ba6cd2d | 167 | enum HttpStep |
| donatien | 0:a2dd0ba6cd2d | 168 | { |
| donatien | 0:a2dd0ba6cd2d | 169 | // HTTP_INIT, |
| donatien | 0:a2dd0ba6cd2d | 170 | HTTP_WRITE_HEADERS, |
| donatien | 0:a2dd0ba6cd2d | 171 | HTTP_WRITE_DATA, |
| donatien | 0:a2dd0ba6cd2d | 172 | HTTP_READ_HEADERS, |
| donatien | 0:a2dd0ba6cd2d | 173 | HTTP_READ_DATA, |
| donatien | 0:a2dd0ba6cd2d | 174 | HTTP_READ_DATA_INCOMPLETE, |
| donatien | 0:a2dd0ba6cd2d | 175 | HTTP_DONE, |
| donatien | 0:a2dd0ba6cd2d | 176 | HTTP_CLOSED |
| donatien | 0:a2dd0ba6cd2d | 177 | }; |
| donatien | 0:a2dd0ba6cd2d | 178 | |
| donatien | 0:a2dd0ba6cd2d | 179 | HttpStep m_state; |
| donatien | 0:a2dd0ba6cd2d | 180 | |
| donatien | 0:a2dd0ba6cd2d | 181 | HttpData* m_pDataOut; |
| donatien | 0:a2dd0ba6cd2d | 182 | HttpData* m_pDataIn; |
| donatien | 0:a2dd0ba6cd2d | 183 | |
| donatien | 0:a2dd0ba6cd2d | 184 | bool m_dataChunked; //Data is encoded as chunks |
| donatien | 0:a2dd0ba6cd2d | 185 | int m_dataPos; //Position in data |
| donatien | 0:a2dd0ba6cd2d | 186 | int m_dataLen; //Data length |
| donatien | 0:a2dd0ba6cd2d | 187 | char* m_buf; |
| donatien | 0:a2dd0ba6cd2d | 188 | char* m_pBufRemaining; //Remaining |
| donatien | 0:a2dd0ba6cd2d | 189 | int m_bufRemainingLen; //Data length in m_pBufRemaining |
| donatien | 0:a2dd0ba6cd2d | 190 | |
| donatien | 0:a2dd0ba6cd2d | 191 | int m_httpResponseCode; |
| donatien | 0:a2dd0ba6cd2d | 192 | |
| donatien | 0:a2dd0ba6cd2d | 193 | HttpResult m_blockingResult; //Result if blocking mode |
| donatien | 0:a2dd0ba6cd2d | 194 | |
| donatien | 0:a2dd0ba6cd2d | 195 | }; |
| donatien | 0:a2dd0ba6cd2d | 196 | |
| donatien | 0:a2dd0ba6cd2d | 197 | //Including data containers here for more convenience |
| donatien | 0:a2dd0ba6cd2d | 198 | #include "data/HttpFile.h" |
| donatien | 0:a2dd0ba6cd2d | 199 | #include "data/HttpStream.h" |
| donatien | 0:a2dd0ba6cd2d | 200 | #include "data/HttpText.h" |
| donatien | 0:a2dd0ba6cd2d | 201 | #include "data/HttpMap.h" |
| donatien | 0:a2dd0ba6cd2d | 202 | |
| donatien | 0:a2dd0ba6cd2d | 203 | #endif |