Simon Ford / NetServices

Version of http://mbed.org/cookbook/NetServicesTribute with setting set the same for LPC2368

Dependents:   UDPSocketExample 24LCxx_I2CApp WeatherPlatform_pachube HvZServerLib ... more

services/http/client/data/HTTPText.h@0:350011bf8be7, 2010-11-23 (annotated)

Committer:
simon
Date:
Tue Nov 23 14:15:36 2010 +0000
Revision:
0:350011bf8be7
Experimental version for testing UDP

Who changed what in which revision?

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