Diff: services/http/client/data/HTTPStream.h

Revision:

9:c79fa4034f5b

Parent:

0:632c9925f013

Child:

10:d098e9192450

--- a/services/http/client/data/HTTPStream.h	Wed Jul 28 12:45:32 2010 +0000
+++ b/services/http/client/data/HTTPStream.h	Thu Aug 05 14:32:43 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 @param buf and size @param 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();