Rahol Rajan / NetServices-Traffic

Used in Live Traffic Update Nokia LCD Display Project

Fork of NetServices by Segundo Equipo

services/http/client/data/HTTPText.h@8:92b57208ab99, 2013-03-06 (annotated)

Committer:
rrajan8
Date:
Wed Mar 06 19:07:23 2013 +0000
Revision:
8:92b57208ab99
Parent:
0:ac1725ba162c 
This project utilizes mbed's networking features to display live traffic updates on the Nokia LCD using the MapQuest API's Traffic Web Service.

Who changed what in which revision?

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