A HTTP Client for the mbed networking libraries, with a longer path field and a manually editable authentication field for Supertweet.net
Fork of HTTPClient by
IHTTPData.h@16:1f743885e7de, 2012-08-30 (annotated)
- Committer:
- donatien
- Date:
- Thu Aug 30 15:38:57 2012 +0000
- Revision:
- 16:1f743885e7de
- Parent:
- 13:be61104f4e91
- Child:
- 17:951bf897ba01
IHTTPData (HTTPText, HTTPMap) objects can be re-used multiple times (reading/writing position is reset on each connection); Support for PUT and DELETE methods
Who changed what in which revision?
User | Revision | Line number | New 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 | 13:be61104f4e91 | 23 | #include <cstring> |
donatien | 13:be61104f4e91 | 24 | |
donatien | 13:be61104f4e91 | 25 | using std::size_t; |
donatien | 13:be61104f4e91 | 26 | |
donatien | 0:2ccb9960a044 | 27 | ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...) |
donatien | 0:2ccb9960a044 | 28 | class IHTTPDataOut |
donatien | 0:2ccb9960a044 | 29 | { |
donatien | 0:2ccb9960a044 | 30 | protected: |
donatien | 0:2ccb9960a044 | 31 | friend class HTTPClient; |
donatien | 16:1f743885e7de | 32 | |
donatien | 16:1f743885e7de | 33 | /** Reset stream to its beginning |
donatien | 16:1f743885e7de | 34 | * Called by the HTTPClient on each new request |
donatien | 16:1f743885e7de | 35 | */ |
donatien | 16:1f743885e7de | 36 | virtual void readReset() = 0; |
donatien | 0:2ccb9960a044 | 37 | |
donatien | 0:2ccb9960a044 | 38 | /** Read a piece of data to be transmitted |
donatien | 0:2ccb9960a044 | 39 | * @param buf Pointer to the buffer on which to copy the data |
donatien | 0:2ccb9960a044 | 40 | * @param len Length of the buffer |
donatien | 0:2ccb9960a044 | 41 | * @param pReadLen Pointer to the variable on which the actual copied data length will be stored |
donatien | 0:2ccb9960a044 | 42 | */ |
donatien | 0:2ccb9960a044 | 43 | virtual int read(char* buf, size_t len, size_t* pReadLen) = 0; |
donatien | 0:2ccb9960a044 | 44 | |
donatien | 0:2ccb9960a044 | 45 | /** Get MIME type |
donatien | 0:2ccb9960a044 | 46 | * @param type Internet media type from Content-Type header |
donatien | 0:2ccb9960a044 | 47 | */ |
donatien | 0:2ccb9960a044 | 48 | virtual int getDataType(char* type, size_t maxTypeLen) = 0; //Internet media type for Content-Type header |
donatien | 0:2ccb9960a044 | 49 | |
donatien | 0:2ccb9960a044 | 50 | /** Determine whether the HTTP client should chunk the data |
donatien | 0:2ccb9960a044 | 51 | * Used for Transfer-Encoding header |
donatien | 0:2ccb9960a044 | 52 | */ |
donatien | 0:2ccb9960a044 | 53 | virtual bool getIsChunked() = 0; |
donatien | 0:2ccb9960a044 | 54 | |
donatien | 0:2ccb9960a044 | 55 | /** If the data is not chunked, get its size |
donatien | 0:2ccb9960a044 | 56 | * Used for Content-Length header |
donatien | 0:2ccb9960a044 | 57 | */ |
donatien | 0:2ccb9960a044 | 58 | virtual size_t getDataLen() = 0; |
donatien | 0:2ccb9960a044 | 59 | |
donatien | 0:2ccb9960a044 | 60 | }; |
donatien | 0:2ccb9960a044 | 61 | |
donatien | 0:2ccb9960a044 | 62 | ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...) |
donatien | 0:2ccb9960a044 | 63 | class IHTTPDataIn |
donatien | 0:2ccb9960a044 | 64 | { |
donatien | 0:2ccb9960a044 | 65 | protected: |
donatien | 0:2ccb9960a044 | 66 | friend class HTTPClient; |
donatien | 0:2ccb9960a044 | 67 | |
donatien | 16:1f743885e7de | 68 | /** Reset stream to its beginning |
donatien | 16:1f743885e7de | 69 | * Called by the HTTPClient on each new request |
donatien | 16:1f743885e7de | 70 | */ |
donatien | 16:1f743885e7de | 71 | virtual void writeReset() = 0; |
donatien | 16:1f743885e7de | 72 | |
donatien | 0:2ccb9960a044 | 73 | /** Write a piece of data transmitted by the server |
donatien | 0:2ccb9960a044 | 74 | * @param buf Pointer to the buffer from which to copy the data |
donatien | 0:2ccb9960a044 | 75 | * @param len Length of the buffer |
donatien | 0:2ccb9960a044 | 76 | */ |
donatien | 0:2ccb9960a044 | 77 | virtual int write(const char* buf, size_t len) = 0; |
donatien | 0:2ccb9960a044 | 78 | |
donatien | 0:2ccb9960a044 | 79 | /** Set MIME type |
donatien | 0:2ccb9960a044 | 80 | * @param type Internet media type from Content-Type header |
donatien | 0:2ccb9960a044 | 81 | */ |
donatien | 0:2ccb9960a044 | 82 | virtual void setDataType(const char* type) = 0; |
donatien | 0:2ccb9960a044 | 83 | |
donatien | 0:2ccb9960a044 | 84 | /** Determine whether the data is chunked |
donatien | 0:2ccb9960a044 | 85 | * Recovered from Transfer-Encoding header |
donatien | 0:2ccb9960a044 | 86 | */ |
donatien | 0:2ccb9960a044 | 87 | virtual void setIsChunked(bool chunked) = 0; |
donatien | 0:2ccb9960a044 | 88 | |
donatien | 0:2ccb9960a044 | 89 | /** If the data is not chunked, set its size |
donatien | 0:2ccb9960a044 | 90 | * From Content-Length header |
donatien | 0:2ccb9960a044 | 91 | */ |
donatien | 0:2ccb9960a044 | 92 | virtual void setDataLen(size_t len) = 0; |
donatien | 0:2ccb9960a044 | 93 | |
donatien | 0:2ccb9960a044 | 94 | }; |
donatien | 0:2ccb9960a044 | 95 | |
donatien | 0:2ccb9960a044 | 96 | #endif |