ST / HTTPClient

HTTP/HTTPS Client Library for the X-NUCLEO-IDW01M1v2 wifi board.

Dependents:   HTTPClient_HelloWorld_IDW01M1 wifigianluigi HTTPClient_HelloWorld_IDW01M1_Fabio_Ricezione

Fork of HTTPClient by ST Expansion SW Team

Embed: (wiki syntax)

« Back to documentation index

IHTTPDataOut Class Reference
Protected Member Functions | Friends

IHTTPDataOut Class Reference

This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...) More...

#include <IHTTPData.h>

Inherits IHTTPData.

Inherited by HTTPMap, and HTTPText.

Protected Member Functions

virtual void readReset ()=0
 Reset stream to its beginning Called by the HTTPClient on each new request.
virtual int read (char *buf, size_t len, size_t *pReadLen)=0
 Read a piece of data to be transmitted.
virtual int getDataType (char *type, size_t maxTypeLen)=0
 Get MIME type.
virtual bool getIsChunked ()=0
 Determine whether the HTTP client should chunk the data Used for Transfer-Encoding header.
virtual size_t getDataLen ()=0
 If the data is not chunked, get its size Used for Content-Length header.
virtual bool getHeader (char *header, size_t maxHeaderLen)
 Get a specific header.

Friends

class HTTPClient

Detailed Description

This is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)

Definition at line 37 of file IHTTPData.h.

Member Function Documentation

virtual size_t getDataLen (  ) [protected, pure virtual]

If the data is not chunked, get its size Used for Content-Length header.

Implemented in HTTPMap, and HTTPText.

virtual int getDataType ( char *  type,
size_t  maxTypeLen 
) [protected, pure virtual]

Get MIME type.

Parameters:
typeInternet media type from Content-Type header

Implemented in HTTPMap, and HTTPText.

virtual bool getHeader ( char *  header,
size_t  maxHeaderLen 
) [protected, virtual, inherited]

Get a specific header.

Definition at line 33 of file IHTTPData.h.

virtual bool getIsChunked (  ) [protected, pure virtual]

Determine whether the HTTP client should chunk the data Used for Transfer-Encoding header.

Implemented in HTTPMap, and HTTPText.

virtual int read ( char *  buf,
size_t  len,
size_t *  pReadLen 
) [protected, pure virtual]

Read a piece of data to be transmitted.

Parameters:
bufPointer to the buffer on which to copy the data
lenLength of the buffer
pReadLenPointer to the variable on which the actual copied data length will be stored

Implemented in HTTPMap, and HTTPText.

virtual void readReset (  ) [protected, pure virtual]

Reset stream to its beginning Called by the HTTPClient on each new request.

Implemented in HTTPMap, and HTTPText.

Generated on Tue Jul 12 2022 21:24:56 by  doxygen 1.7.2