NetServices Stack source

Dependents:   HelloWorld ServoInterfaceBoardExample1 4180_Lab4

Embed: (wiki syntax)

« Back to documentation index

HTTPStream Class Reference

HTTPStream Class Reference

HTTP Client Streaming tool. More...

#include <HTTPStream.h>

Inherits HTTPData.

Public Member Functions

 HTTPStream ()
 Instantiates the object.
void readNext (byte *buf, int size)
 Starts to read into buffer.
bool readable ()
 Returns whether there is data available to read.
int readLen ()
 Returns the actual length of the payload written in the buffer.

Friends

class HTTPClient

Detailed Description

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.

Definition at line 41 of file HTTPStream.h.


Constructor & Destructor Documentation

HTTPStream (  )

Instantiates the object.

Definition at line 28 of file HTTPStream.cpp.


Member Function Documentation

bool readable (  )

Returns whether there is data available to read.

Definition at line 46 of file HTTPStream.cpp.

int readLen (  )

Returns the actual length of the payload written in the buffer.

Definition at line 51 of file HTTPStream.cpp.

void readNext ( byte *  buf,
int  size 
)

Starts to read into buffer.

Passes a buffer of address buf and size 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.

Definition at line 39 of file HTTPStream.cpp.