Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/services/http/client/data/HTTPStream.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michael J. Spencer 1:f5ac63519541 1
Michael J. Spencer 1:f5ac63519541 2 /*
Michael J. Spencer 1:f5ac63519541 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Michael J. Spencer 1:f5ac63519541 4
Michael J. Spencer 1:f5ac63519541 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Michael J. Spencer 1:f5ac63519541 6 of this software and associated documentation files (the "Software"), to deal
Michael J. Spencer 1:f5ac63519541 7 in the Software without restriction, including without limitation the rights
Michael J. Spencer 1:f5ac63519541 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Michael J. Spencer 1:f5ac63519541 9 copies of the Software, and to permit persons to whom the Software is
Michael J. Spencer 1:f5ac63519541 10 furnished to do so, subject to the following conditions:
Michael J. Spencer 1:f5ac63519541 11
Michael J. Spencer 1:f5ac63519541 12 The above copyright notice and this permission notice shall be included in
Michael J. Spencer 1:f5ac63519541 13 all copies or substantial portions of the Software.
Michael J. Spencer 1:f5ac63519541 14
Michael J. Spencer 1:f5ac63519541 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Michael J. Spencer 1:f5ac63519541 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Michael J. Spencer 1:f5ac63519541 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Michael J. Spencer 1:f5ac63519541 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Michael J. Spencer 1:f5ac63519541 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Michael J. Spencer 1:f5ac63519541 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Michael J. Spencer 1:f5ac63519541 21 THE SOFTWARE.
Michael J. Spencer 1:f5ac63519541 22 */
Michael J. Spencer 1:f5ac63519541 23
Michael J. Spencer 1:f5ac63519541 24 #ifndef HTTP_STREAM_H
Michael J. Spencer 1:f5ac63519541 25 #define HTTP_STREAM_H
Michael J. Spencer 1:f5ac63519541 26
Michael J. Spencer 1:f5ac63519541 27 #include "../HTTPData.h"
Michael J. Spencer 1:f5ac63519541 28 #include "mbed.h"
Michael J. Spencer 1:f5ac63519541 29
Michael J. Spencer 1:f5ac63519541 30 /** \file
Michael J. Spencer 1:f5ac63519541 31 HTTP Stream data source/sink header file
Michael J. Spencer 1:f5ac63519541 32 */
Michael J. Spencer 1:f5ac63519541 33
Michael J. Spencer 1:f5ac63519541 34 typedef uint8_t byte;
Michael J. Spencer 1:f5ac63519541 35
Michael J. Spencer 1:f5ac63519541 36 ///HTTP Client Streaming tool
Michael J. Spencer 1:f5ac63519541 37 /**
Michael J. Spencer 1:f5ac63519541 38 This class allows you to stream data from the web using a persisting HTTP connection.
Michael J. Spencer 1:f5ac63519541 39 To use it properly you must use a non-blocking HTTPClient method.
Michael J. Spencer 1:f5ac63519541 40 */
Michael J. Spencer 1:f5ac63519541 41 class HTTPStream : public HTTPData //Streaming buf
Michael J. Spencer 1:f5ac63519541 42 {
Michael J. Spencer 1:f5ac63519541 43 public:
Michael J. Spencer 1:f5ac63519541 44 ///Instantiates the object
Michael J. Spencer 1:f5ac63519541 45 HTTPStream();
Michael J. Spencer 1:f5ac63519541 46 virtual ~HTTPStream();
Michael J. Spencer 1:f5ac63519541 47
Michael J. Spencer 1:f5ac63519541 48 ///Starts to read into buffer
Michael J. Spencer 1:f5ac63519541 49 /**
Michael J. Spencer 1:f5ac63519541 50 Passes a buffer of address @a buf and size @a size to the instance.
Michael J. Spencer 1:f5ac63519541 51 When it receives data it will be stored in this buffer.
Michael J. Spencer 1:f5ac63519541 52 When the buffer is full it throttles the client until this function is called again.
Michael J. Spencer 1:f5ac63519541 53 */
Michael J. Spencer 1:f5ac63519541 54 void readNext(byte* buf, int size);
Michael J. Spencer 1:f5ac63519541 55
Michael J. Spencer 1:f5ac63519541 56 ///Returns whether there is data available to read
Michael J. Spencer 1:f5ac63519541 57 bool readable();
Michael J. Spencer 1:f5ac63519541 58
Michael J. Spencer 1:f5ac63519541 59 ///Returns the actual length of the payload written in the buffer
Michael J. Spencer 1:f5ac63519541 60 int readLen();
Michael J. Spencer 1:f5ac63519541 61
Michael J. Spencer 1:f5ac63519541 62 virtual void clear();
Michael J. Spencer 1:f5ac63519541 63
Michael J. Spencer 1:f5ac63519541 64 protected:
Michael J. Spencer 1:f5ac63519541 65 virtual int read(char* buf, int len);
Michael J. Spencer 1:f5ac63519541 66 virtual int write(const char* buf, int len);
Michael J. Spencer 1:f5ac63519541 67
Michael J. Spencer 1:f5ac63519541 68 virtual string getDataType(); //Internet media type for Content-Type header
Michael J. Spencer 1:f5ac63519541 69 virtual void setDataType(const string& type); //Internet media type from Content-Type header
Michael J. Spencer 1:f5ac63519541 70
Michael J. Spencer 1:f5ac63519541 71 virtual bool getIsChunked(); //For Transfer-Encoding header
Michael J. Spencer 1:f5ac63519541 72 virtual void setIsChunked(bool chunked); //From Transfer-Encoding header
Michael J. Spencer 1:f5ac63519541 73
Michael J. Spencer 1:f5ac63519541 74 virtual int getDataLen(); //For Content-Length header
Michael J. Spencer 1:f5ac63519541 75 virtual void setDataLen(int len); //From Content-Length header, or if the transfer is chunked, next chunk length
Michael J. Spencer 1:f5ac63519541 76
Michael J. Spencer 1:f5ac63519541 77 private:
Michael J. Spencer 1:f5ac63519541 78 byte* m_buf;
Michael J. Spencer 1:f5ac63519541 79 int m_size; //Capacity
Michael J. Spencer 1:f5ac63519541 80 int m_len; //Length
Michael J. Spencer 1:f5ac63519541 81 };
Michael J. Spencer 1:f5ac63519541 82
Michael J. Spencer 1:f5ac63519541 83 #endif