Rahol Rajan / NetServices-Traffic

Used in Live Traffic Update Nokia LCD Display Project

Fork of NetServices by Segundo Equipo

services/http/client/data/HTTPStream.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 #ifndef HTTP_STREAM_H
segundo 0:ac1725ba162c 25 #define HTTP_STREAM_H
segundo 0:ac1725ba162c 26
segundo 0:ac1725ba162c 27 #include "../HTTPData.h"
segundo 0:ac1725ba162c 28 #include "mbed.h"
segundo 0:ac1725ba162c 29
segundo 0:ac1725ba162c 30 /** \file
segundo 0:ac1725ba162c 31 HTTP Stream data source/sink header file
segundo 0:ac1725ba162c 32 */
segundo 0:ac1725ba162c 33
segundo 0:ac1725ba162c 34 typedef uint8_t byte;
segundo 0:ac1725ba162c 35
segundo 0:ac1725ba162c 36 ///HTTP Client Streaming tool
segundo 0:ac1725ba162c 37 /**
segundo 0:ac1725ba162c 38 This class allows you to stream data from the web using a persisting HTTP connection.
segundo 0:ac1725ba162c 39 To use it properly you must use a non-blocking HTTPClient method.
segundo 0:ac1725ba162c 40 */
segundo 0:ac1725ba162c 41 class HTTPStream : public HTTPData //Streaming buf
segundo 0:ac1725ba162c 42 {
segundo 0:ac1725ba162c 43 public:
segundo 0:ac1725ba162c 44 ///Instantiates the object
segundo 0:ac1725ba162c 45 HTTPStream();
segundo 0:ac1725ba162c 46 virtual ~HTTPStream();
segundo 0:ac1725ba162c 47
segundo 0:ac1725ba162c 48 ///Starts to read into buffer
segundo 0:ac1725ba162c 49 /**
segundo 0:ac1725ba162c 50 Passes a buffer of address @a buf and size @a size to the instance.
segundo 0:ac1725ba162c 51 When it receives data it will be stored in this buffer.
segundo 0:ac1725ba162c 52 When the buffer is full it throttles the client until this function is called again.
segundo 0:ac1725ba162c 53 */
segundo 0:ac1725ba162c 54 void readNext(byte* buf, int size);
segundo 0:ac1725ba162c 55
segundo 0:ac1725ba162c 56 ///Returns whether there is data available to read
segundo 0:ac1725ba162c 57 bool readable();
segundo 0:ac1725ba162c 58
segundo 0:ac1725ba162c 59 ///Returns the actual length of the payload written in the buffer
segundo 0:ac1725ba162c 60 int readLen();
segundo 0:ac1725ba162c 61
segundo 0:ac1725ba162c 62 virtual void clear();
segundo 0:ac1725ba162c 63
segundo 0:ac1725ba162c 64 protected:
segundo 0:ac1725ba162c 65 virtual int read(char* buf, int len);
segundo 0:ac1725ba162c 66 virtual int write(const char* buf, int len);
segundo 0:ac1725ba162c 67
segundo 0:ac1725ba162c 68 virtual string getDataType(); //Internet media type for Content-Type header
segundo 0:ac1725ba162c 69 virtual void setDataType(const string& type); //Internet media type from Content-Type header
segundo 0:ac1725ba162c 70
segundo 0:ac1725ba162c 71 virtual bool getIsChunked(); //For Transfer-Encoding header
segundo 0:ac1725ba162c 72 virtual void setIsChunked(bool chunked); //From Transfer-Encoding header
segundo 0:ac1725ba162c 73
segundo 0:ac1725ba162c 74 virtual int getDataLen(); //For Content-Length header
segundo 0:ac1725ba162c 75 virtual void setDataLen(int len); //From Content-Length header, or if the transfer is chunked, next chunk length
segundo 0:ac1725ba162c 76
segundo 0:ac1725ba162c 77 private:
segundo 0:ac1725ba162c 78 byte* m_buf;
segundo 0:ac1725ba162c 79 int m_size; //Capacity
segundo 0:ac1725ba162c 80 int m_len; //Length
segundo 0:ac1725ba162c 81 };
segundo 0:ac1725ba162c 82
segundo 0:ac1725ba162c 83 #endif