Ollie Milton / HTTPClient

A HTTP Client for the mbed networking libraries with HTTPFile for use with latest networking stack

Fork of HTTPClient by Donatien Garnier

An extension of the HTTPClient that adds HTTPFile. Currently on get is support and only works when getting binary files.

HTTPFile data("/local/firm.bin");
HTTPResult r = client.get("https://217.140.101.20/media/uploads/ollie8/firm.bin", &data);
if (r == HTTP_OK) {
                            
}

IHTTPData.h@10:e1351de84c16, 2012-07-18 (annotated)

Committer:
donatien
Date:
Wed Jul 18 15:40:04 2012 +0000
Revision:
10:e1351de84c16
Parent:
0:2ccb9960a044
Child:
13:be61104f4e91
Corrected licence headers

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:2ccb9960a044 1 /* IHTTPData.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 #ifndef IHTTPDATA_H
donatien 0:2ccb9960a044 21 #define IHTTPDATA_H
donatien 0:2ccb9960a044 22
donatien 0:2ccb9960a044 23 ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
donatien 0:2ccb9960a044 24 class IHTTPDataOut
donatien 0:2ccb9960a044 25 {
donatien 0:2ccb9960a044 26 protected:
donatien 0:2ccb9960a044 27 friend class HTTPClient;
donatien 0:2ccb9960a044 28
donatien 0:2ccb9960a044 29 /** Read a piece of data to be transmitted
donatien 0:2ccb9960a044 30 * @param buf Pointer to the buffer on which to copy the data
donatien 0:2ccb9960a044 31 * @param len Length of the buffer
donatien 0:2ccb9960a044 32 * @param pReadLen Pointer to the variable on which the actual copied data length will be stored
donatien 0:2ccb9960a044 33 */
donatien 0:2ccb9960a044 34 virtual int read(char* buf, size_t len, size_t* pReadLen) = 0;
donatien 0:2ccb9960a044 35
donatien 0:2ccb9960a044 36 /** Get MIME type
donatien 0:2ccb9960a044 37 * @param type Internet media type from Content-Type header
donatien 0:2ccb9960a044 38 */
donatien 0:2ccb9960a044 39 virtual int getDataType(char* type, size_t maxTypeLen) = 0; //Internet media type for Content-Type header
donatien 0:2ccb9960a044 40
donatien 0:2ccb9960a044 41 /** Determine whether the HTTP client should chunk the data
donatien 0:2ccb9960a044 42 * Used for Transfer-Encoding header
donatien 0:2ccb9960a044 43 */
donatien 0:2ccb9960a044 44 virtual bool getIsChunked() = 0;
donatien 0:2ccb9960a044 45
donatien 0:2ccb9960a044 46 /** If the data is not chunked, get its size
donatien 0:2ccb9960a044 47 * Used for Content-Length header
donatien 0:2ccb9960a044 48 */
donatien 0:2ccb9960a044 49 virtual size_t getDataLen() = 0;
donatien 0:2ccb9960a044 50
donatien 0:2ccb9960a044 51 };
donatien 0:2ccb9960a044 52
donatien 0:2ccb9960a044 53 ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
donatien 0:2ccb9960a044 54 class IHTTPDataIn
donatien 0:2ccb9960a044 55 {
donatien 0:2ccb9960a044 56 protected:
donatien 0:2ccb9960a044 57 friend class HTTPClient;
donatien 0:2ccb9960a044 58
donatien 0:2ccb9960a044 59 /** Write a piece of data transmitted by the server
donatien 0:2ccb9960a044 60 * @param buf Pointer to the buffer from which to copy the data
donatien 0:2ccb9960a044 61 * @param len Length of the buffer
donatien 0:2ccb9960a044 62 */
donatien 0:2ccb9960a044 63 virtual int write(const char* buf, size_t len) = 0;
donatien 0:2ccb9960a044 64
donatien 0:2ccb9960a044 65 /** Set MIME type
donatien 0:2ccb9960a044 66 * @param type Internet media type from Content-Type header
donatien 0:2ccb9960a044 67 */
donatien 0:2ccb9960a044 68 virtual void setDataType(const char* type) = 0;
donatien 0:2ccb9960a044 69
donatien 0:2ccb9960a044 70 /** Determine whether the data is chunked
donatien 0:2ccb9960a044 71 * Recovered from Transfer-Encoding header
donatien 0:2ccb9960a044 72 */
donatien 0:2ccb9960a044 73 virtual void setIsChunked(bool chunked) = 0;
donatien 0:2ccb9960a044 74
donatien 0:2ccb9960a044 75 /** If the data is not chunked, set its size
donatien 0:2ccb9960a044 76 * From Content-Length header
donatien 0:2ccb9960a044 77 */
donatien 0:2ccb9960a044 78 virtual void setDataLen(size_t len) = 0;
donatien 0:2ccb9960a044 79
donatien 0:2ccb9960a044 80 };
donatien 0:2ccb9960a044 81
donatien 0:2ccb9960a044 82 #endif