Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/services/http/client/data/HTTPText.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

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