HTTP Client library
Dependents: weather_LCD_display News_LCD_display TwitterExample_1 GeoLocation_LCD_Display ... more
Diff: LPC2368/services/http/client/data/HTTPStream.h
- Revision:
- 5:d0be6af2d1db
- Parent:
- 0:a828ace1f38d
--- a/LPC2368/services/http/client/data/HTTPStream.h Fri Jul 09 14:35:21 2010 +0000 +++ b/LPC2368/services/http/client/data/HTTPStream.h Thu Aug 05 15:09:46 2010 +0000 @@ -27,18 +27,36 @@ #include "../HTTPData.h" #include "mbed.h" +/** \file +HTTP Stream data source/sink header file +*/ + typedef uint8_t byte; +///HTTP Client Streaming tool +/** +This class allows you to stream data from the web using a persisting HTTP connection. +To use it properly you must use a non-blocking HTTPClient method. +*/ class HTTPStream : public HTTPData //Streaming buf { public: + ///Instantiates the object HTTPStream(); virtual ~HTTPStream(); + ///Starts to read into buffer + /** + Passes a buffer of address @a buf and size @a size to the instance. + When it receives data it will be stored in this buffer. + When the buffer is full it throttles the client until this function is called again. + */ void readNext(byte* buf, int size); + ///Returns whether there is data available to read bool readable(); + ///Returns the actual length of the payload written in the buffer int readLen(); virtual void clear();