Vincent Wochnik / HTTPClient

Fork with custom headers and basic auth.

Dependents:   MbedSmartRest

Fork of HTTPClient by Kazushi Mukaiyama

HTTPClient.h@23:9386b15b0820, 2014-02-05 (annotated)

Committer:
vwochnik
Date:
Wed Feb 05 16:21:39 2014 +0000
Revision:
23:9386b15b0820
Parent:
22:967c00d70d95 
fix

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:2ccb9960a044 1 /* HTTPClient.h */
donatien 10:e1351de84c16 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 10:e1351de84c16 3 *
donatien 10:e1351de84c16 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 10:e1351de84c16 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 10:e1351de84c16 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 10:e1351de84c16 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 10:e1351de84c16 8 * furnished to do so, subject to the following conditions:
donatien 10:e1351de84c16 9 *
donatien 10:e1351de84c16 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 10:e1351de84c16 11 * substantial portions of the Software.
donatien 10:e1351de84c16 12 *
donatien 10:e1351de84c16 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 10:e1351de84c16 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 10:e1351de84c16 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 10:e1351de84c16 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 10:e1351de84c16 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 10:e1351de84c16 18 */
donatien 0:2ccb9960a044 19
donatien 0:2ccb9960a044 20 /** \file
donatien 0:2ccb9960a044 21 HTTP Client header file
donatien 0:2ccb9960a044 22 */
donatien 0:2ccb9960a044 23
donatien 0:2ccb9960a044 24 #ifndef HTTP_CLIENT_H
donatien 0:2ccb9960a044 25 #define HTTP_CLIENT_H
donatien 0:2ccb9960a044 26
donatien 11:390362de8c3f 27 #include "TCPSocketConnection.h"
donatien 0:2ccb9960a044 28
vwochnik 22:967c00d70d95 29 #define HTTP_CLIENT_DEFAULT_TIMEOUT 60000
donatien 0:2ccb9960a044 30
donatien 0:2ccb9960a044 31 class HTTPData;
donatien 0:2ccb9960a044 32
donatien 0:2ccb9960a044 33 #include "IHTTPData.h"
donatien 0:2ccb9960a044 34 #include "mbed.h"
donatien 0:2ccb9960a044 35
donatien 0:2ccb9960a044 36 ///HTTP client results
donatien 0:2ccb9960a044 37 enum HTTPResult
donatien 0:2ccb9960a044 38 {
donatien 0:2ccb9960a044 39 HTTP_PROCESSING, ///<Processing
donatien 0:2ccb9960a044 40 HTTP_PARSE, ///<url Parse error
donatien 0:2ccb9960a044 41 HTTP_DNS, ///<Could not resolve name
donatien 0:2ccb9960a044 42 HTTP_PRTCL, ///<Protocol error
donatien 0:2ccb9960a044 43 HTTP_NOTFOUND, ///<HTTP 404 Error
donatien 0:2ccb9960a044 44 HTTP_REFUSED, ///<HTTP 403 Error
donatien 0:2ccb9960a044 45 HTTP_ERROR, ///<HTTP xxx error
donatien 0:2ccb9960a044 46 HTTP_TIMEOUT, ///<Connection timeout
donatien 11:390362de8c3f 47 HTTP_CONN, ///<Connection error
donatien 11:390362de8c3f 48 HTTP_CLOSED, ///<Connection was closed by remote host
donatien 11:390362de8c3f 49 HTTP_OK = 0, ///<Success
donatien 0:2ccb9960a044 50 };
donatien 0:2ccb9960a044 51
donatien 0:2ccb9960a044 52 /**A simple HTTP Client
donatien 0:2ccb9960a044 53 The HTTPClient is composed of:
donatien 0:2ccb9960a044 54 - The actual client (HTTPClient)
donatien 0:2ccb9960a044 55 - 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 0:2ccb9960a044 56 */
donatien 0:2ccb9960a044 57 class HTTPClient
donatien 0:2ccb9960a044 58 {
donatien 0:2ccb9960a044 59 public:
donatien 0:2ccb9960a044 60 ///Instantiate the HTTP client
donatien 0:2ccb9960a044 61 HTTPClient();
donatien 0:2ccb9960a044 62 ~HTTPClient();
donatien 0:2ccb9960a044 63
donatien 0:2ccb9960a044 64 /**
donatien 0:2ccb9960a044 65 Provides a basic authentification feature (Base64 encoded username and password)
donatien 0:2ccb9960a044 66 Pass two NULL pointers to switch back to no authentication
donatien 0:2ccb9960a044 67 @param user username to use for authentication, must remain valid durlng the whole HTTP session
donatien 0:2ccb9960a044 68 @param user password to use for authentication, must remain valid durlng the whole HTTP session
donatien 0:2ccb9960a044 69 */
donatien 0:2ccb9960a044 70 void basicAuth(const char* user, const char* password); //Basic Authentification
vwochnik 19:bcbf0af9fac3 71
vwochnik 19:bcbf0af9fac3 72 /**
vwochnik 19:bcbf0af9fac3 73 Set custom headers for request.
vwochnik 19:bcbf0af9fac3 74 Pass NULL, 0 to turn off custom headers.
vwochnik 19:bcbf0af9fac3 75 @param headers an array (size multiple of two) key-value pairs, must remain valid during the whole HTTP session
vwochnik 19:bcbf0af9fac3 76 @param pairs number of key-value pairs
vwochnik 19:bcbf0af9fac3 77 */
vwochnik 19:bcbf0af9fac3 78 void customHeaders(const char** headers, size_t pairs);
donatien 0:2ccb9960a044 79
donatien 0:2ccb9960a044 80 //High Level setup functions
donatien 16:1f743885e7de 81 /** Execute a GET request on the URL
donatien 0:2ccb9960a044 82 Blocks until completion
donatien 0:2ccb9960a044 83 @param url : url on which to execute the request
donatien 0:2ccb9960a044 84 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
donatien 0:2ccb9960a044 85 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
donatien 12:89d09a6db00a 86 @return 0 on success, HTTP error (<0) on failure
donatien 0:2ccb9960a044 87 */
donatien 12:89d09a6db00a 88 HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien 0:2ccb9960a044 89
donatien 16:1f743885e7de 90 /** Execute a GET request on the URL
donatien 0:2ccb9960a044 91 Blocks until completion
donatien 0:2ccb9960a044 92 This is a helper to directly get a piece of text from a HTTP result
donatien 0:2ccb9960a044 93 @param url : url on which to execute the request
donatien 0:2ccb9960a044 94 @param result : pointer to a char array in which the result will be stored
donatien 0:2ccb9960a044 95 @param maxResultLen : length of the char array (including space for the NULL-terminating char)
donatien 0:2ccb9960a044 96 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
donatien 12:89d09a6db00a 97 @return 0 on success, HTTP error (<0) on failure
donatien 0:2ccb9960a044 98 */
donatien 12:89d09a6db00a 99 HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien 0:2ccb9960a044 100
donatien 16:1f743885e7de 101 /** Execute a POST request on the URL
donatien 0:2ccb9960a044 102 Blocks until completion
donatien 0:2ccb9960a044 103 @param url : url on which to execute the request
donatien 0:2ccb9960a044 104 @param dataOut : a IHTTPDataOut instance that contains the data that will be posted
donatien 0:2ccb9960a044 105 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
donatien 0:2ccb9960a044 106 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
donatien 12:89d09a6db00a 107 @return 0 on success, HTTP error (<0) on failure
donatien 0:2ccb9960a044 108 */
donatien 12:89d09a6db00a 109 HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien 0:2ccb9960a044 110
donatien 16:1f743885e7de 111 /** Execute a PUT request on the URL
donatien 16:1f743885e7de 112 Blocks until completion
donatien 16:1f743885e7de 113 @param url : url on which to execute the request
donatien 16:1f743885e7de 114 @param dataOut : a IHTTPDataOut instance that contains the data that will be put
donatien 16:1f743885e7de 115 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
donatien 16:1f743885e7de 116 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
donatien 16:1f743885e7de 117 @return 0 on success, HTTP error (<0) on failure
donatien 16:1f743885e7de 118 */
donatien 16:1f743885e7de 119 HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien 16:1f743885e7de 120
donatien 16:1f743885e7de 121 /** Execute a DELETE request on the URL
donatien 16:1f743885e7de 122 Blocks until completion
donatien 16:1f743885e7de 123 @param url : url on which to execute the request
donatien 16:1f743885e7de 124 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
donatien 16:1f743885e7de 125 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
donatien 16:1f743885e7de 126 @return 0 on success, HTTP error (<0) on failure
donatien 16:1f743885e7de 127 */
donatien 16:1f743885e7de 128 HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien 16:1f743885e7de 129
donatien 0:2ccb9960a044 130 /** Get last request's HTTP response code
donatien 0:2ccb9960a044 131 @return The HTTP response code of the last request
donatien 0:2ccb9960a044 132 */
donatien 0:2ccb9960a044 133 int getHTTPResponseCode();
donatien 0:2ccb9960a044 134
donatien 0:2ccb9960a044 135 private:
donatien 0:2ccb9960a044 136 enum HTTP_METH
donatien 0:2ccb9960a044 137 {
donatien 0:2ccb9960a044 138 HTTP_GET,
donatien 0:2ccb9960a044 139 HTTP_POST,
donatien 16:1f743885e7de 140 HTTP_PUT,
donatien 16:1f743885e7de 141 HTTP_DELETE,
donatien 0:2ccb9960a044 142 HTTP_HEAD
donatien 0:2ccb9960a044 143 };
donatien 0:2ccb9960a044 144
donatien 12:89d09a6db00a 145 HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
donatien 11:390362de8c3f 146 HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
donatien 11:390362de8c3f 147 HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
donatien 11:390362de8c3f 148 HTTPResult parseURL(const char* url, char* scheme, size_t maxSchemeLen, char* host, size_t maxHostLen, uint16_t* port, char* path, size_t maxPathLen); //Parse URL
kazushi2008 18:cf5d7427a9ec 149 void createauth (const char *user, const char *pwd, char *buf, int len);
kazushi2008 18:cf5d7427a9ec 150 int base64enc(const char *input, unsigned int length, char *output, int len);
donatien 0:2ccb9960a044 151
donatien 0:2ccb9960a044 152 //Parameters
donatien 11:390362de8c3f 153 TCPSocketConnection m_sock;
donatien 7:4e39864f7b15 154
donatien 12:89d09a6db00a 155 int m_timeout;
donatien 0:2ccb9960a044 156
donatien 0:2ccb9960a044 157 const char* m_basicAuthUser;
donatien 0:2ccb9960a044 158 const char* m_basicAuthPassword;
vwochnik 19:bcbf0af9fac3 159 const char** m_customHeaders;
vwochnik 19:bcbf0af9fac3 160 size_t m_nCustomHeaders;
donatien 0:2ccb9960a044 161 int m_httpResponseCode;
donatien 0:2ccb9960a044 162
donatien 0:2ccb9960a044 163 };
donatien 0:2ccb9960a044 164
donatien 0:2ccb9960a044 165 //Including data containers here for more convenience
donatien 0:2ccb9960a044 166 #include "data/HTTPText.h"
donatien 0:2ccb9960a044 167 #include "data/HTTPMap.h"
donatien 0:2ccb9960a044 168
donatien 0:2ccb9960a044 169 #endif