Pranav Sawant / HTTPClient

Oct122012mbedLab

Dependents:   Lab3_VoiceMeter

Fork of HTTPClient by masa haru

LPC1768/services/http/client/data/HTTPStream.h@1:b77740c0a846, 2012-10-12 (annotated)

Committer:
psawant9
Date:
Fri Oct 12 16:02:09 2012 +0000
Revision:
1:b77740c0a846
Parent:
0:62fac7f06c8d 
Done

Who changed what in which revision?

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