Donatien Garnier / HTTPClientLibBeta

IHTTPData.h@0:7aca7353eebf, 2012-07-06 (annotated)

Committer:
donatien
Date:
Fri Jul 06 10:22:15 2012 +0000
Revision:
0:7aca7353eebf
Fixed parseURL issue for port parsing

Who changed what in which revision?

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