Rob Toulson / HTTPClient

RobT's fork of HTTPClient library

Fork of HTTPClient_ToBeRemoved by Donatien Garnier

data/HTTPText.h@7:d97a4fc01c86, 2012-04-19 (annotated)

Committer:
donatien
Date:
Thu Apr 19 09:52:54 2012 +0000
Revision:
7:d97a4fc01c86
Parent:
6:3d3824893be1 
Documentation++

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 6:3d3824893be1 1 /* HTTPText.h */
donatien 6:3d3824893be1 2 /*
donatien 6:3d3824893be1 3 Copyright (C) 2012 ARM Limited.
donatien 6:3d3824893be1 4
donatien 6:3d3824893be1 5 Permission is hereby granted, free of charge, to any person obtaining a copy of
donatien 6:3d3824893be1 6 this software and associated documentation files (the "Software"), to deal in
donatien 6:3d3824893be1 7 the Software without restriction, including without limitation the rights to
donatien 6:3d3824893be1 8 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
donatien 6:3d3824893be1 9 of the Software, and to permit persons to whom the Software is furnished to do
donatien 6:3d3824893be1 10 so, subject to the following conditions:
donatien 6:3d3824893be1 11
donatien 6:3d3824893be1 12 The above copyright notice and this permission notice shall be included in all
donatien 6:3d3824893be1 13 copies or substantial portions of the Software.
donatien 6:3d3824893be1 14
donatien 6:3d3824893be1 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
donatien 6:3d3824893be1 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
donatien 6:3d3824893be1 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
donatien 6:3d3824893be1 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
donatien 6:3d3824893be1 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 6:3d3824893be1 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
donatien 6:3d3824893be1 21 SOFTWARE.
donatien 6:3d3824893be1 22 */
donatien 6:3d3824893be1 23
donatien 6:3d3824893be1 24
donatien 6:3d3824893be1 25 #ifndef HTTPTEXT_H_
donatien 6:3d3824893be1 26 #define HTTPTEXT_H_
donatien 6:3d3824893be1 27
donatien 6:3d3824893be1 28 #include "../IHTTPData.h"
donatien 6:3d3824893be1 29
donatien 7:d97a4fc01c86 30 /** A data endopint to store text
donatien 7:d97a4fc01c86 31 */
donatien 6:3d3824893be1 32 class HTTPText : public IHTTPDataIn, public IHTTPDataOut
donatien 6:3d3824893be1 33 {
donatien 6:3d3824893be1 34 public:
donatien 7:d97a4fc01c86 35 /** Create an HTTPText instance for output
donatien 7:d97a4fc01c86 36 * @param str String to be transmitted
donatien 7:d97a4fc01c86 37 */
donatien 6:3d3824893be1 38 HTTPText(char* str);
donatien 7:d97a4fc01c86 39
donatien 7:d97a4fc01c86 40 /** Create an HTTPText instance for input
donatien 7:d97a4fc01c86 41 * @param str Buffer to store the incoming string
donatien 7:d97a4fc01c86 42 * @param size Size of the buffer
donatien 7:d97a4fc01c86 43 */
donatien 6:3d3824893be1 44 HTTPText(char* str, size_t size);
donatien 6:3d3824893be1 45
donatien 6:3d3824893be1 46 protected:
donatien 6:3d3824893be1 47 //IHTTPDataIn
donatien 6:3d3824893be1 48 virtual int read(char* buf, size_t len, size_t* pReadLen);
donatien 6:3d3824893be1 49
donatien 6:3d3824893be1 50 virtual int getDataType(char* type, size_t maxTypeLen); //Internet media type for Content-Type header
donatien 6:3d3824893be1 51
donatien 6:3d3824893be1 52 virtual bool getIsChunked(); //For Transfer-Encoding header
donatien 6:3d3824893be1 53
donatien 6:3d3824893be1 54 virtual size_t getDataLen(); //For Content-Length header
donatien 6:3d3824893be1 55
donatien 6:3d3824893be1 56 //IHTTPDataOut
donatien 6:3d3824893be1 57 virtual int write(const char* buf, size_t len);
donatien 6:3d3824893be1 58
donatien 6:3d3824893be1 59 virtual void setDataType(const char* type); //Internet media type from Content-Type header
donatien 6:3d3824893be1 60
donatien 6:3d3824893be1 61 virtual void setIsChunked(bool chunked); //From Transfer-Encoding header
donatien 6:3d3824893be1 62
donatien 6:3d3824893be1 63 virtual void setDataLen(size_t len); //From Content-Length header, or if the transfer is chunked, next chunk length
donatien 6:3d3824893be1 64
donatien 6:3d3824893be1 65 private:
donatien 6:3d3824893be1 66 char* m_str;
donatien 6:3d3824893be1 67 size_t m_size;
donatien 6:3d3824893be1 68
donatien 6:3d3824893be1 69 size_t m_pos;
donatien 6:3d3824893be1 70 };
donatien 6:3d3824893be1 71
donatien 6:3d3824893be1 72 #endif /* HTTPTEXT_H_ */