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