Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

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