ban4jp - / iSDIO

iSDIO Library for TOSHIBA FlashAir. include HTTP or HTTPS Client.

Dependencies:   SDFileSystem

Dependents:   FlashAir_Twitter Neon_F303K8_04

Fork of HTTPClient by Donatien Garnier

IHTTPData.h@20:51abf34bcc06, 2014-12-15 (annotated)

Committer:
ban4jp
Date:
Mon Dec 15 12:23:22 2014 +0000
Revision:
20:51abf34bcc06
Parent:
19:3b1625dbd7e9 
Initial commit.

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 17:679e15a3d3db 27 class IHTTPData
donatien 17:679e15a3d3db 28 {
ban4jp 19:3b1625dbd7e9 29 protected:
ban4jp 19:3b1625dbd7e9 30 /** Get a specific header
ban4jp 19:3b1625dbd7e9 31 *
ban4jp 19:3b1625dbd7e9 32 */
ban4jp 19:3b1625dbd7e9 33 virtual bool getHeader(char* header, size_t maxHeaderLen) {
ban4jp 19:3b1625dbd7e9 34 return false;
ban4jp 19:3b1625dbd7e9 35 }
donatien 17:679e15a3d3db 36 };
donatien 17:679e15a3d3db 37
donatien 0:2ccb9960a044 38 ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
donatien 17:679e15a3d3db 39 class IHTTPDataOut : public IHTTPData
donatien 0:2ccb9960a044 40 {
donatien 0:2ccb9960a044 41 protected:
ban4jp 19:3b1625dbd7e9 42 friend class HTTPClient;
ban4jp 19:3b1625dbd7e9 43
ban4jp 19:3b1625dbd7e9 44 /** Reset stream to its beginning
ban4jp 19:3b1625dbd7e9 45 * Called by the HTTPClient on each new request
ban4jp 19:3b1625dbd7e9 46 */
ban4jp 19:3b1625dbd7e9 47 virtual void readReset() = 0;
ban4jp 19:3b1625dbd7e9 48
ban4jp 19:3b1625dbd7e9 49 /** Read a piece of data to be transmitted
ban4jp 19:3b1625dbd7e9 50 * @param buf Pointer to the buffer on which to copy the data
ban4jp 19:3b1625dbd7e9 51 * @param len Length of the buffer
ban4jp 19:3b1625dbd7e9 52 * @param pReadLen Pointer to the variable on which the actual copied data length will be stored
ban4jp 19:3b1625dbd7e9 53 */
ban4jp 19:3b1625dbd7e9 54 virtual int read(char* buf, size_t len, size_t* pReadLen) = 0;
donatien 0:2ccb9960a044 55
ban4jp 19:3b1625dbd7e9 56 /** Get MIME type
ban4jp 19:3b1625dbd7e9 57 * @param type Internet media type from Content-Type header
ban4jp 19:3b1625dbd7e9 58 */
ban4jp 19:3b1625dbd7e9 59 virtual int getDataType(char* type, size_t maxTypeLen) = 0; //Internet media type for Content-Type header
ban4jp 19:3b1625dbd7e9 60
ban4jp 19:3b1625dbd7e9 61 /** Determine whether the HTTP client should chunk the data
ban4jp 19:3b1625dbd7e9 62 * Used for Transfer-Encoding header
ban4jp 19:3b1625dbd7e9 63 */
ban4jp 19:3b1625dbd7e9 64 virtual bool getIsChunked() = 0;
ban4jp 19:3b1625dbd7e9 65
ban4jp 19:3b1625dbd7e9 66 /** If the data is not chunked, get its size
ban4jp 19:3b1625dbd7e9 67 * Used for Content-Length header
ban4jp 19:3b1625dbd7e9 68 */
ban4jp 19:3b1625dbd7e9 69 virtual size_t getDataLen() = 0;
donatien 0:2ccb9960a044 70
donatien 0:2ccb9960a044 71 };
donatien 0:2ccb9960a044 72
donatien 0:2ccb9960a044 73 ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
donatien 17:679e15a3d3db 74 class IHTTPDataIn : public IHTTPData
donatien 0:2ccb9960a044 75 {
donatien 0:2ccb9960a044 76 protected:
ban4jp 19:3b1625dbd7e9 77 friend class HTTPClient;
donatien 0:2ccb9960a044 78
ban4jp 19:3b1625dbd7e9 79 /** Reset stream to its beginning
ban4jp 19:3b1625dbd7e9 80 * Called by the HTTPClient on each new request
ban4jp 19:3b1625dbd7e9 81 */
ban4jp 19:3b1625dbd7e9 82 virtual void writeReset() = 0;
donatien 16:1f743885e7de 83
ban4jp 19:3b1625dbd7e9 84 /** Write a piece of data transmitted by the server
ban4jp 19:3b1625dbd7e9 85 * @param buf Pointer to the buffer from which to copy the data
ban4jp 19:3b1625dbd7e9 86 * @param len Length of the buffer
ban4jp 19:3b1625dbd7e9 87 */
ban4jp 19:3b1625dbd7e9 88 virtual int write(const char* buf, size_t len) = 0;
donatien 0:2ccb9960a044 89
ban4jp 19:3b1625dbd7e9 90 /** Set MIME type
ban4jp 19:3b1625dbd7e9 91 * @param type Internet media type from Content-Type header
ban4jp 19:3b1625dbd7e9 92 */
ban4jp 19:3b1625dbd7e9 93 virtual void setDataType(const char* type) = 0;
donatien 0:2ccb9960a044 94
ban4jp 19:3b1625dbd7e9 95 /** Determine whether the data is chunked
ban4jp 19:3b1625dbd7e9 96 * Recovered from Transfer-Encoding header
ban4jp 19:3b1625dbd7e9 97 */
ban4jp 19:3b1625dbd7e9 98 virtual void setIsChunked(bool chunked) = 0;
ban4jp 19:3b1625dbd7e9 99
ban4jp 19:3b1625dbd7e9 100 /** If the data is not chunked, set its size
ban4jp 19:3b1625dbd7e9 101 * From Content-Length header
ban4jp 19:3b1625dbd7e9 102 */
ban4jp 19:3b1625dbd7e9 103 virtual void setDataLen(size_t len) = 0;
donatien 0:2ccb9960a044 104
donatien 0:2ccb9960a044 105 };
donatien 0:2ccb9960a044 106
donatien 0:2ccb9960a044 107 #endif