joshua Elsdon / Mbed 2 deprecated Email2Screen

Mac addr added ICRS

Dependencies:   mbed

Fork of Email2Screen by Oliver Mattos

NetServicesProxy/services/http/client/data/HTTPText.h@1:b38b745d1ea8, 2013-11-20 (annotated)

Committer:
je310
Date:
Wed Nov 20 21:22:22 2013 +0000
Revision:
1:b38b745d1ea8
Parent:
0:1619a6b826d7 
This is a maced version of olivers code ICRS

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Hello1024 0:1619a6b826d7 1
Hello1024 0:1619a6b826d7 2 /*
Hello1024 0:1619a6b826d7 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Hello1024 0:1619a6b826d7 4
Hello1024 0:1619a6b826d7 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Hello1024 0:1619a6b826d7 6 of this software and associated documentation files (the "Software"), to deal
Hello1024 0:1619a6b826d7 7 in the Software without restriction, including without limitation the rights
Hello1024 0:1619a6b826d7 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Hello1024 0:1619a6b826d7 9 copies of the Software, and to permit persons to whom the Software is
Hello1024 0:1619a6b826d7 10 furnished to do so, subject to the following conditions:
Hello1024 0:1619a6b826d7 11
Hello1024 0:1619a6b826d7 12 The above copyright notice and this permission notice shall be included in
Hello1024 0:1619a6b826d7 13 all copies or substantial portions of the Software.
Hello1024 0:1619a6b826d7 14
Hello1024 0:1619a6b826d7 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Hello1024 0:1619a6b826d7 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Hello1024 0:1619a6b826d7 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Hello1024 0:1619a6b826d7 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Hello1024 0:1619a6b826d7 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Hello1024 0:1619a6b826d7 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Hello1024 0:1619a6b826d7 21 THE SOFTWARE.
Hello1024 0:1619a6b826d7 22 */
Hello1024 0:1619a6b826d7 23
Hello1024 0:1619a6b826d7 24 /** \file
Hello1024 0:1619a6b826d7 25 HTTP Text data source/sink header file
Hello1024 0:1619a6b826d7 26 */
Hello1024 0:1619a6b826d7 27
Hello1024 0:1619a6b826d7 28 #ifndef HTTP_TEXT_H
Hello1024 0:1619a6b826d7 29 #define HTTP_TEXT_H
Hello1024 0:1619a6b826d7 30
Hello1024 0:1619a6b826d7 31 #include "../HTTPData.h"
Hello1024 0:1619a6b826d7 32 #include "mbed.h"
Hello1024 0:1619a6b826d7 33
Hello1024 0:1619a6b826d7 34 #define DEFAULT_MAX_MEM_ALLOC 512 //Avoid out-of-memory problems
Hello1024 0:1619a6b826d7 35
Hello1024 0:1619a6b826d7 36 ///HTTP Client data container for text
Hello1024 0:1619a6b826d7 37 /**
Hello1024 0:1619a6b826d7 38 This is a simple "Text" data repository for HTTP requests.
Hello1024 0:1619a6b826d7 39 */
Hello1024 0:1619a6b826d7 40 class HTTPText : public HTTPData //Simple Text I/O
Hello1024 0:1619a6b826d7 41 {
Hello1024 0:1619a6b826d7 42 public:
Hello1024 0:1619a6b826d7 43 ///Instantiates the object.
Hello1024 0:1619a6b826d7 44 /**
Hello1024 0:1619a6b826d7 45 @param encoding encoding of the data, it defaults to text/html.
Hello1024 0:1619a6b826d7 46 @param maxSize defines the maximum memory size that can be allocated by the object. It defaults to 512 bytes.
Hello1024 0:1619a6b826d7 47 */
Hello1024 0:1619a6b826d7 48 HTTPText(const string& encoding = "text/html", int maxSize = DEFAULT_MAX_MEM_ALLOC);
Hello1024 0:1619a6b826d7 49 virtual ~HTTPText();
Hello1024 0:1619a6b826d7 50
Hello1024 0:1619a6b826d7 51 ///Gets text
Hello1024 0:1619a6b826d7 52 /**
Hello1024 0:1619a6b826d7 53 Returns the text in the container as a zero-terminated char*.
Hello1024 0:1619a6b826d7 54 The array returned points to the internal buffer of the object and remains owned by the object.
Hello1024 0:1619a6b826d7 55 */
Hello1024 0:1619a6b826d7 56 const char* gets() const;
Hello1024 0:1619a6b826d7 57
Hello1024 0:1619a6b826d7 58 //Puts text
Hello1024 0:1619a6b826d7 59 /**
Hello1024 0:1619a6b826d7 60 Sets the text in the container using a zero-terminated char*.
Hello1024 0:1619a6b826d7 61 */
Hello1024 0:1619a6b826d7 62 void puts(const char* str);
Hello1024 0:1619a6b826d7 63
Hello1024 0:1619a6b826d7 64 ///Gets text
Hello1024 0:1619a6b826d7 65 /**
Hello1024 0:1619a6b826d7 66 Returns the text in the container as string.
Hello1024 0:1619a6b826d7 67 */
Hello1024 0:1619a6b826d7 68 string& get();
Hello1024 0:1619a6b826d7 69
Hello1024 0:1619a6b826d7 70 ///Puts text
Hello1024 0:1619a6b826d7 71 /**
Hello1024 0:1619a6b826d7 72 Sets the text in the container as string.
Hello1024 0:1619a6b826d7 73 */
Hello1024 0:1619a6b826d7 74 void set(const string& str);
Hello1024 0:1619a6b826d7 75
Hello1024 0:1619a6b826d7 76 ///Clears the content.
Hello1024 0:1619a6b826d7 77 /**
Hello1024 0:1619a6b826d7 78 If this container is used as a data sink, it is cleared by the HTTP Client at the beginning of the request.
Hello1024 0:1619a6b826d7 79 */
Hello1024 0:1619a6b826d7 80 virtual void clear();
Hello1024 0:1619a6b826d7 81
Hello1024 0:1619a6b826d7 82 protected:
Hello1024 0:1619a6b826d7 83 virtual int read(char* buf, int len);
Hello1024 0:1619a6b826d7 84 virtual int write(const char* buf, int len);
Hello1024 0:1619a6b826d7 85
Hello1024 0:1619a6b826d7 86 virtual string getDataType(); //Internet media type for Content-Type header
Hello1024 0:1619a6b826d7 87 virtual void setDataType(const string& type); //Internet media type from Content-Type header
Hello1024 0:1619a6b826d7 88
Hello1024 0:1619a6b826d7 89 virtual bool getIsChunked(); //For Transfer-Encoding header
Hello1024 0:1619a6b826d7 90 virtual void setIsChunked(bool chunked); //From Transfer-Encoding header
Hello1024 0:1619a6b826d7 91
Hello1024 0:1619a6b826d7 92 virtual int getDataLen(); //For Content-Length header
Hello1024 0:1619a6b826d7 93 virtual void setDataLen(int len); //From Content-Length header, or if the transfer is chunked, next chunk length
Hello1024 0:1619a6b826d7 94
Hello1024 0:1619a6b826d7 95 private:
Hello1024 0:1619a6b826d7 96 string m_buf;
Hello1024 0:1619a6b826d7 97 string m_encoding;
Hello1024 0:1619a6b826d7 98 int m_maxSize;
Hello1024 0:1619a6b826d7 99 };
Hello1024 0:1619a6b826d7 100
Hello1024 0:1619a6b826d7 101 #endif