joshua Elsdon / Mbed 2 deprecated Email2Screen

Mac addr added ICRS

Dependencies:   mbed

Fork of Email2Screen by Oliver Mattos

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