HTTPClient.h

00001 /* HTTPClient.h */
00002 /* Copyright (C) 2012 mbed.org, MIT License
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00005  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00006  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00007  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00008  * furnished to do so, subject to the following conditions:
00009  *
00010  * The above copyright notice and this permission notice shall be included in all copies or
00011  * substantial portions of the Software.
00012  *
00013  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00014  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00015  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00016  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00017  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00018  */
00019 
00020 /** \file
00021 HTTP Client header file
00022 */
00023 
00024 #ifndef HTTP_CLIENT_H
00025 #define HTTP_CLIENT_H
00026 
00027 #define HTTP_CLIENT_DEFAULT_TIMEOUT 15000
00028 #define MAX_HEADER_COUNT 3
00029 
00030 class HTTPData;
00031 
00032 #include "IHTTPData.h"
00033 #include "mbed.h"
00034 
00035 ///HTTP client results
00036 enum HTTPResult {
00037     HTTP_PROCESSING, ///<Processing
00038     HTTP_PARSE, ///<url Parse error
00039     HTTP_DNS, ///<Could not resolve name
00040     HTTP_PRTCL, ///<Protocol error
00041     HTTP_NOTFOUND, ///<HTTP 404 Error
00042     HTTP_REFUSED, ///<HTTP 403 Error
00043     HTTP_ERROR, ///<HTTP xxx error
00044     HTTP_TIMEOUT, ///<Connection timeout
00045     HTTP_CONN, ///<Connection error
00046     HTTP_CLOSED, ///<Connection was closed by remote host
00047     HTTP_REDIRECT, ///<HTTP 300 - 303
00048     HTTP_OK = 0, ///<Success
00049 };
00050 
00051 /**A simple HTTP Client
00052 The HTTPClient is composed of:
00053 - The actual client (HTTPClient)
00054 - 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)
00055 */
00056 class HTTPClient
00057 {
00058 public:
00059     ///Instantiate the HTTP client
00060     HTTPClient();
00061     ~HTTPClient();
00062 
00063     /**
00064     Provides a basic authentification feature (Base64 encoded username and password)
00065     Pass two NULL pointers to switch back to no authentication
00066     @param user username to use for authentication, must remain valid durlng the whole HTTP session
00067     @param user password to use for authentication, must remain valid durlng the whole HTTP session
00068     */
00069     HTTPResult basicAuth(const char* user, const char* password); //Basic Authentification
00070 
00071     //High Level setup functions
00072     /** Execute a GET request on the URL
00073     Blocks until completion
00074     @param url : url on which to execute the request
00075     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00076     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00077     @return 0 on success, HTTP error (<0) on failure
00078     */
00079     HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00080 
00081     /** Execute a GET request on the URL
00082     Blocks until completion
00083     This is a helper to directly get a piece of text from a HTTP result
00084     @param url : url on which to execute the request
00085     @param result : pointer to a char array in which the result will be stored
00086     @param maxResultLen : length of the char array (including space for the NULL-terminating char)
00087     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00088     @return 0 on success, HTTP error (<0) on failure
00089     */
00090     HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00091 
00092     /** Execute a POST request on the URL
00093     Blocks until completion
00094     @param url : url on which to execute the request
00095     @param dataOut : a IHTTPDataOut instance that contains the data that will be posted
00096     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00097     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00098     @return 0 on success, HTTP error (<0) on failure
00099     */
00100     HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00101 
00102     /** Execute a PUT request on the URL
00103     Blocks until completion
00104     @param url : url on which to execute the request
00105     @param dataOut : a IHTTPDataOut instance that contains the data that will be put
00106     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00107     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00108     @return 0 on success, HTTP error (<0) on failure
00109     */
00110     HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00111 
00112     /** Execute a DELETE request on the URL
00113     Blocks until completion
00114     @param url : url on which to execute the request
00115     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00116     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00117     @return 0 on success, HTTP error (<0) on failure
00118     */
00119     HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00120 
00121     /** Get last request's HTTP response code
00122     @return The HTTP response code of the last request
00123     */
00124     int getHTTPResponseCode();
00125     
00126     void setHeader(int idx, char *header) ;   /* set http headers */
00127     HTTPResult setSSLversion(int minorV) ; /* set SSL/TLS version. 0: SSL3, 1: TLS1.0, 2: TLS1.1, 3: TLS1.2 */
00128     void setLocationBuf(char *url, int size) ; /* set URL buffer for redirection */
00129 
00130 private:
00131     enum HTTP_METH {
00132         HTTP_GET,
00133         HTTP_POST,
00134         HTTP_PUT,
00135         HTTP_DELETE,
00136         HTTP_HEAD
00137     };
00138 
00139     HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
00140     HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
00141     HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
00142     HTTPResult flush(void); //0 on success, err code on failure
00143     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
00144     void cyassl_free(void) ;
00145     HTTPResult bAuth(void) ;
00146     HTTPResult readHeader(void) ;
00147     
00148     //Parameters
00149 
00150     int m_timeout;
00151 
00152     const char* m_basicAuthUser;
00153     const char* m_basicAuthPassword;
00154     int m_httpResponseCode;
00155 
00156     char * redirect_url ;
00157     int    redirect_url_size ;
00158     int    redirect ;
00159 
00160     char * header[MAX_HEADER_COUNT] ;
00161     
00162     /* for CyaSSL */
00163     int    SSLver ;
00164     uint16_t port;
00165     struct CYASSL_CTX* ctx ;
00166     struct CYASSL    * ssl ;
00167 };
00168 
00169 //Including data containers here for more convenience
00170 #include "data/HTTPText.h"
00171 #include "data/HTTPMap.h"
00172 
00173 #endif