xiaorui qu / HTTPClient

Fork HTTPClient and Modfiy code for mbed 6.0

Dependents:   mbed-demo-http-get-json

IHTTPData.h@32:7b9919d59194, 2014-10-11 (annotated)

Committer:
WiredHome
Date:
Sat Oct 11 17:26:04 2014 +0000
Revision:
32:7b9919d59194
Parent:
16:1f743885e7de 
Documentation updates only.

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 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
WiredHome 32:7b9919d59194 39 * @param[out] buf Pointer to the buffer on which to copy the data
WiredHome 32:7b9919d59194 40 * @param[in] len Length of the buffer
WiredHome 32:7b9919d59194 41 * @param[out] 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
WiredHome 32:7b9919d59194 46 * @param[out] type Internet media type from Content-Type header
WiredHome 32:7b9919d59194 47 * @param[in] maxTypeLen is the size of the type buffer to write to
donatien 0:2ccb9960a044 48 */
donatien 0:2ccb9960a044 49 virtual int getDataType(char* type, size_t maxTypeLen) = 0; //Internet media type for Content-Type header
donatien 0:2ccb9960a044 50
donatien 0:2ccb9960a044 51 /** Determine whether the HTTP client should chunk the data
donatien 0:2ccb9960a044 52 * Used for Transfer-Encoding header
donatien 0:2ccb9960a044 53 */
donatien 0:2ccb9960a044 54 virtual bool getIsChunked() = 0;
donatien 0:2ccb9960a044 55
donatien 0:2ccb9960a044 56 /** If the data is not chunked, get its size
donatien 0:2ccb9960a044 57 * Used for Content-Length header
donatien 0:2ccb9960a044 58 */
donatien 0:2ccb9960a044 59 virtual size_t getDataLen() = 0;
donatien 0:2ccb9960a044 60
donatien 0:2ccb9960a044 61 };
donatien 0:2ccb9960a044 62
donatien 0:2ccb9960a044 63 ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
donatien 0:2ccb9960a044 64 class IHTTPDataIn
donatien 0:2ccb9960a044 65 {
donatien 0:2ccb9960a044 66 protected:
donatien 0:2ccb9960a044 67 friend class HTTPClient;
donatien 0:2ccb9960a044 68
donatien 16:1f743885e7de 69 /** Reset stream to its beginning
donatien 16:1f743885e7de 70 * Called by the HTTPClient on each new request
donatien 16:1f743885e7de 71 */
donatien 16:1f743885e7de 72 virtual void writeReset() = 0;
donatien 16:1f743885e7de 73
donatien 0:2ccb9960a044 74 /** Write a piece of data transmitted by the server
donatien 0:2ccb9960a044 75 * @param buf Pointer to the buffer from which to copy the data
donatien 0:2ccb9960a044 76 * @param len Length of the buffer
donatien 0:2ccb9960a044 77 */
donatien 0:2ccb9960a044 78 virtual int write(const char* buf, size_t len) = 0;
donatien 0:2ccb9960a044 79
donatien 0:2ccb9960a044 80 /** Set MIME type
donatien 0:2ccb9960a044 81 * @param type Internet media type from Content-Type header
donatien 0:2ccb9960a044 82 */
donatien 0:2ccb9960a044 83 virtual void setDataType(const char* type) = 0;
donatien 0:2ccb9960a044 84
donatien 0:2ccb9960a044 85 /** Determine whether the data is chunked
donatien 0:2ccb9960a044 86 * Recovered from Transfer-Encoding header
donatien 0:2ccb9960a044 87 */
donatien 0:2ccb9960a044 88 virtual void setIsChunked(bool chunked) = 0;
donatien 0:2ccb9960a044 89
donatien 0:2ccb9960a044 90 /** If the data is not chunked, set its size
donatien 0:2ccb9960a044 91 * From Content-Length header
donatien 0:2ccb9960a044 92 */
donatien 0:2ccb9960a044 93 virtual void setDataLen(size_t len) = 0;
donatien 0:2ccb9960a044 94
donatien 0:2ccb9960a044 95 };
donatien 0:2ccb9960a044 96
donatien 0:2ccb9960a044 97 #endif