Junichi Katsu / SimpleIoTBoardLib

Simple IoT Board用のライブラリです。 ESP8266ライブラリの軽量化 送信のみのソフトシリアルライブラリを含んでいます。

Dependents:   SITB_HttpGetSample SITB_IFTTTSample SITB_INA226PRC AmbientExampleSITB ... more

HTTPClient/IHTTPData.h@0:890c12951e96, 2015-11-15 (annotated)

Committer:
jksoft
Date:
Sun Nov 15 13:36:44 2015 +0000
Revision:
0:890c12951e96
??

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jksoft 0:890c12951e96 1 /* IHTTPData.h */
jksoft 0:890c12951e96 2 /* Copyright (C) 2012 mbed.org, MIT License
jksoft 0:890c12951e96 3 *
jksoft 0:890c12951e96 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
jksoft 0:890c12951e96 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
jksoft 0:890c12951e96 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
jksoft 0:890c12951e96 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
jksoft 0:890c12951e96 8 * furnished to do so, subject to the following conditions:
jksoft 0:890c12951e96 9 *
jksoft 0:890c12951e96 10 * The above copyright notice and this permission notice shall be included in all copies or
jksoft 0:890c12951e96 11 * substantial portions of the Software.
jksoft 0:890c12951e96 12 *
jksoft 0:890c12951e96 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
jksoft 0:890c12951e96 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
jksoft 0:890c12951e96 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
jksoft 0:890c12951e96 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jksoft 0:890c12951e96 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
jksoft 0:890c12951e96 18 */
jksoft 0:890c12951e96 19
jksoft 0:890c12951e96 20 #ifndef IHTTPDATA_H
jksoft 0:890c12951e96 21 #define IHTTPDATA_H
jksoft 0:890c12951e96 22
jksoft 0:890c12951e96 23 #include <cstring>
jksoft 0:890c12951e96 24
jksoft 0:890c12951e96 25 using std::size_t;
jksoft 0:890c12951e96 26
jksoft 0:890c12951e96 27 class IHTTPData
jksoft 0:890c12951e96 28 {
jksoft 0:890c12951e96 29 protected:
jksoft 0:890c12951e96 30 /** Get a specific header
jksoft 0:890c12951e96 31 *
jksoft 0:890c12951e96 32 */
jksoft 0:890c12951e96 33 virtual bool getHeader(char* header, size_t maxHeaderLen) { return false; }
jksoft 0:890c12951e96 34 };
jksoft 0:890c12951e96 35
jksoft 0:890c12951e96 36 ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
jksoft 0:890c12951e96 37 class IHTTPDataOut : public IHTTPData
jksoft 0:890c12951e96 38 {
jksoft 0:890c12951e96 39 protected:
jksoft 0:890c12951e96 40 friend class HTTPClient;
jksoft 0:890c12951e96 41
jksoft 0:890c12951e96 42 /** Reset stream to its beginning
jksoft 0:890c12951e96 43 * Called by the HTTPClient on each new request
jksoft 0:890c12951e96 44 */
jksoft 0:890c12951e96 45 virtual void readReset() = 0;
jksoft 0:890c12951e96 46
jksoft 0:890c12951e96 47 /** Read a piece of data to be transmitted
jksoft 0:890c12951e96 48 * @param buf Pointer to the buffer on which to copy the data
jksoft 0:890c12951e96 49 * @param len Length of the buffer
jksoft 0:890c12951e96 50 * @param pReadLen Pointer to the variable on which the actual copied data length will be stored
jksoft 0:890c12951e96 51 */
jksoft 0:890c12951e96 52 virtual int read(char* buf, size_t len, size_t* pReadLen) = 0;
jksoft 0:890c12951e96 53
jksoft 0:890c12951e96 54 /** Get MIME type
jksoft 0:890c12951e96 55 * @param type Internet media type from Content-Type header
jksoft 0:890c12951e96 56 */
jksoft 0:890c12951e96 57 virtual int getDataType(char* type, size_t maxTypeLen) = 0; //Internet media type for Content-Type header
jksoft 0:890c12951e96 58
jksoft 0:890c12951e96 59 /** Determine whether the HTTP client should chunk the data
jksoft 0:890c12951e96 60 * Used for Transfer-Encoding header
jksoft 0:890c12951e96 61 */
jksoft 0:890c12951e96 62 virtual bool getIsChunked() = 0;
jksoft 0:890c12951e96 63
jksoft 0:890c12951e96 64 /** If the data is not chunked, get its size
jksoft 0:890c12951e96 65 * Used for Content-Length header
jksoft 0:890c12951e96 66 */
jksoft 0:890c12951e96 67 virtual size_t getDataLen() = 0;
jksoft 0:890c12951e96 68
jksoft 0:890c12951e96 69 };
jksoft 0:890c12951e96 70
jksoft 0:890c12951e96 71 ///This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
jksoft 0:890c12951e96 72 class IHTTPDataIn : public IHTTPData
jksoft 0:890c12951e96 73 {
jksoft 0:890c12951e96 74 protected:
jksoft 0:890c12951e96 75 friend class HTTPClient;
jksoft 0:890c12951e96 76
jksoft 0:890c12951e96 77 /** Reset stream to its beginning
jksoft 0:890c12951e96 78 * Called by the HTTPClient on each new request
jksoft 0:890c12951e96 79 */
jksoft 0:890c12951e96 80 virtual void writeReset() = 0;
jksoft 0:890c12951e96 81
jksoft 0:890c12951e96 82 /** Write a piece of data transmitted by the server
jksoft 0:890c12951e96 83 * @param buf Pointer to the buffer from which to copy the data
jksoft 0:890c12951e96 84 * @param len Length of the buffer
jksoft 0:890c12951e96 85 */
jksoft 0:890c12951e96 86 virtual int write(const char* buf, size_t len) = 0;
jksoft 0:890c12951e96 87
jksoft 0:890c12951e96 88 /** Set MIME type
jksoft 0:890c12951e96 89 * @param type Internet media type from Content-Type header
jksoft 0:890c12951e96 90 */
jksoft 0:890c12951e96 91 virtual void setDataType(const char* type) = 0;
jksoft 0:890c12951e96 92
jksoft 0:890c12951e96 93 /** Determine whether the data is chunked
jksoft 0:890c12951e96 94 * Recovered from Transfer-Encoding header
jksoft 0:890c12951e96 95 */
jksoft 0:890c12951e96 96 virtual void setIsChunked(bool chunked) = 0;
jksoft 0:890c12951e96 97
jksoft 0:890c12951e96 98 /** If the data is not chunked, set its size
jksoft 0:890c12951e96 99 * From Content-Length header
jksoft 0:890c12951e96 100 */
jksoft 0:890c12951e96 101 virtual void setDataLen(size_t len) = 0;
jksoft 0:890c12951e96 102
jksoft 0:890c12951e96 103 };
jksoft 0:890c12951e96 104
jksoft 0:890c12951e96 105 #endif