Yodiwo / HTTPClient

fork of HTTPClient, adding custom content type for HTTPText (for now)

Fork of HTTPClient by wolf SSL

HTTPClient.h@22:4b9a4151cc73, 2014-07-12 (annotated)

Committer:
wolfSSL
Date:
Sat Jul 12 07:08:10 2014 +0000
Revision:
22:4b9a4151cc73
Parent:
19:1e2f05809eb1
Child:
26:bf979804b653
Add basic authentication;

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 12:89d09a6db00a 27 #define HTTP_CLIENT_DEFAULT_TIMEOUT 15000
donatien 0:2ccb9960a044 28
donatien 0:2ccb9960a044 29 class HTTPData;
donatien 0:2ccb9960a044 30
donatien 0:2ccb9960a044 31 #include "IHTTPData.h"
donatien 0:2ccb9960a044 32 #include "mbed.h"
donatien 0:2ccb9960a044 33
donatien 0:2ccb9960a044 34 ///HTTP client results
wolfSSL 18:d89df40b4cf3 35 enum HTTPResult {
wolfSSL 18:d89df40b4cf3 36 HTTP_PROCESSING, ///<Processing
wolfSSL 18:d89df40b4cf3 37 HTTP_PARSE, ///<url Parse error
wolfSSL 18:d89df40b4cf3 38 HTTP_DNS, ///<Could not resolve name
wolfSSL 18:d89df40b4cf3 39 HTTP_PRTCL, ///<Protocol error
wolfSSL 18:d89df40b4cf3 40 HTTP_NOTFOUND, ///<HTTP 404 Error
wolfSSL 18:d89df40b4cf3 41 HTTP_REFUSED, ///<HTTP 403 Error
wolfSSL 18:d89df40b4cf3 42 HTTP_ERROR, ///<HTTP xxx error
wolfSSL 18:d89df40b4cf3 43 HTTP_TIMEOUT, ///<Connection timeout
wolfSSL 18:d89df40b4cf3 44 HTTP_CONN, ///<Connection error
wolfSSL 18:d89df40b4cf3 45 HTTP_CLOSED, ///<Connection was closed by remote host
wolfSSL 18:d89df40b4cf3 46 HTTP_OK = 0, ///<Success
donatien 0:2ccb9960a044 47 };
donatien 0:2ccb9960a044 48
donatien 0:2ccb9960a044 49 /**A simple HTTP Client
donatien 0:2ccb9960a044 50 The HTTPClient is composed of:
donatien 0:2ccb9960a044 51 - The actual client (HTTPClient)
donatien 0:2ccb9960a044 52 - 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 53 */
donatien 0:2ccb9960a044 54 class HTTPClient
donatien 0:2ccb9960a044 55 {
donatien 0:2ccb9960a044 56 public:
wolfSSL 18:d89df40b4cf3 57 ///Instantiate the HTTP client
wolfSSL 18:d89df40b4cf3 58 HTTPClient();
wolfSSL 18:d89df40b4cf3 59 ~HTTPClient();
wolfSSL 18:d89df40b4cf3 60
wolfSSL 18:d89df40b4cf3 61 /**
wolfSSL 18:d89df40b4cf3 62 Provides a basic authentification feature (Base64 encoded username and password)
wolfSSL 18:d89df40b4cf3 63 Pass two NULL pointers to switch back to no authentication
wolfSSL 18:d89df40b4cf3 64 @param user username to use for authentication, must remain valid durlng the whole HTTP session
wolfSSL 18:d89df40b4cf3 65 @param user password to use for authentication, must remain valid durlng the whole HTTP session
wolfSSL 18:d89df40b4cf3 66 */
wolfSSL 22:4b9a4151cc73 67 HTTPResult basicAuth(const char* user, const char* password); //Basic Authentification
wolfSSL 18:d89df40b4cf3 68
wolfSSL 18:d89df40b4cf3 69 //High Level setup functions
wolfSSL 18:d89df40b4cf3 70 /** Execute a GET request on the URL
wolfSSL 18:d89df40b4cf3 71 Blocks until completion
wolfSSL 18:d89df40b4cf3 72 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 73 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 74 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 75 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 76 */
wolfSSL 18:d89df40b4cf3 77 HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 78
wolfSSL 18:d89df40b4cf3 79 /** Execute a GET request on the URL
wolfSSL 18:d89df40b4cf3 80 Blocks until completion
wolfSSL 18:d89df40b4cf3 81 This is a helper to directly get a piece of text from a HTTP result
wolfSSL 18:d89df40b4cf3 82 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 83 @param result : pointer to a char array in which the result will be stored
wolfSSL 18:d89df40b4cf3 84 @param maxResultLen : length of the char array (including space for the NULL-terminating char)
wolfSSL 18:d89df40b4cf3 85 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 86 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 87 */
wolfSSL 18:d89df40b4cf3 88 HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 89
wolfSSL 18:d89df40b4cf3 90 /** Execute a POST request on the URL
wolfSSL 18:d89df40b4cf3 91 Blocks until completion
wolfSSL 18:d89df40b4cf3 92 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 93 @param dataOut : a IHTTPDataOut instance that contains the data that will be posted
wolfSSL 18:d89df40b4cf3 94 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 95 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 96 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 97 */
wolfSSL 18:d89df40b4cf3 98 HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien 0:2ccb9960a044 99
wolfSSL 18:d89df40b4cf3 100 /** Execute a PUT request on the URL
wolfSSL 18:d89df40b4cf3 101 Blocks until completion
wolfSSL 18:d89df40b4cf3 102 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 103 @param dataOut : a IHTTPDataOut instance that contains the data that will be put
wolfSSL 18:d89df40b4cf3 104 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 105 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 106 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 107 */
wolfSSL 18:d89df40b4cf3 108 HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 109
wolfSSL 18:d89df40b4cf3 110 /** Execute a DELETE request on the URL
wolfSSL 18:d89df40b4cf3 111 Blocks until completion
wolfSSL 18:d89df40b4cf3 112 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 113 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 114 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 115 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 116 */
wolfSSL 18:d89df40b4cf3 117 HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 118
wolfSSL 18:d89df40b4cf3 119 /** Get last request's HTTP response code
wolfSSL 18:d89df40b4cf3 120 @return The HTTP response code of the last request
wolfSSL 18:d89df40b4cf3 121 */
wolfSSL 18:d89df40b4cf3 122 int getHTTPResponseCode();
wolfSSL 22:4b9a4151cc73 123
wolfSSL 22:4b9a4151cc73 124 void setHeader(char *header) ; /* set http headers */
wolfSSL 22:4b9a4151cc73 125 HTTPResult setSSLversion(int minorV) ; /* set SSL/TLS version. 0: SSL3, 1: TLS1.0, 2: TLS1.1, 3: TLS1.2 */
wolfSSL 18:d89df40b4cf3 126
donatien 0:2ccb9960a044 127 private:
wolfSSL 18:d89df40b4cf3 128 enum HTTP_METH {
wolfSSL 18:d89df40b4cf3 129 HTTP_GET,
wolfSSL 18:d89df40b4cf3 130 HTTP_POST,
wolfSSL 18:d89df40b4cf3 131 HTTP_PUT,
wolfSSL 18:d89df40b4cf3 132 HTTP_DELETE,
wolfSSL 18:d89df40b4cf3 133 HTTP_HEAD
wolfSSL 18:d89df40b4cf3 134 };
wolfSSL 18:d89df40b4cf3 135
wolfSSL 18:d89df40b4cf3 136 HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
wolfSSL 18:d89df40b4cf3 137 HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
wolfSSL 18:d89df40b4cf3 138 HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
wolfSSL 18:d89df40b4cf3 139 HTTPResult flush(void); //0 on success, err code on failure
wolfSSL 18:d89df40b4cf3 140 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
wolfSSL 18:d89df40b4cf3 141 void cyassl_free(void) ;
wolfSSL 22:4b9a4151cc73 142 HTTPResult bAuth(void) ;
wolfSSL 22:4b9a4151cc73 143
wolfSSL 18:d89df40b4cf3 144 //Parameters
wolfSSL 18:d89df40b4cf3 145
wolfSSL 18:d89df40b4cf3 146 int m_timeout;
donatien 0:2ccb9960a044 147
wolfSSL 18:d89df40b4cf3 148 const char* m_basicAuthUser;
wolfSSL 18:d89df40b4cf3 149 const char* m_basicAuthPassword;
wolfSSL 18:d89df40b4cf3 150 int m_httpResponseCode;
donatien 0:2ccb9960a044 151
wolfSSL 18:d89df40b4cf3 152 char * header ;
wolfSSL 22:4b9a4151cc73 153
wolfSSL 18:d89df40b4cf3 154 /* for CyaSSL */
wolfSSL 22:4b9a4151cc73 155 int SSLver ;
wolfSSL 18:d89df40b4cf3 156 uint16_t port;
wolfSSL 18:d89df40b4cf3 157 struct CYASSL_CTX* ctx ;
wolfSSL 18:d89df40b4cf3 158 struct CYASSL * ssl ;
donatien 0:2ccb9960a044 159 };
donatien 0:2ccb9960a044 160
donatien 0:2ccb9960a044 161 //Including data containers here for more convenience
donatien 0:2ccb9960a044 162 #include "data/HTTPText.h"
donatien 0:2ccb9960a044 163 #include "data/HTTPMap.h"
donatien 0:2ccb9960a044 164
donatien 0:2ccb9960a044 165 #endif