Junichi Katsu / SimpleIoTBoardLib

Simple IoT Board用のライブラリです。 ESP8266ライブラリの軽量化 送信のみのソフトシリアルライブラリを含んでいます。

Dependents:   SITB_HttpGetSample SITB_IFTTTSample SITB_INA226PRC AmbientExampleSITB ... more

Embed: (wiki syntax)

« Back to documentation index

HTTPText Class Reference
Public Member Functions | Protected Member Functions | Friends

HTTPText Class Reference

A data endpoint to store text. More...

#include <HTTPText.h>

Inherits IHTTPDataIn, and IHTTPDataOut.

Public Member Functions

 HTTPText (char *str)
 Create an HTTPText instance for output.
 HTTPText (char *str, size_t size)
 Create an HTTPText instance for input.

Protected Member Functions

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

Friends

class HTTPClient
class HTTPClient

Detailed Description

A data endpoint to store text.

Definition at line 28 of file HTTPText.h.

Constructor & Destructor Documentation

HTTPText ( char *  str )

Create an HTTPText instance for output.

Parameters:
strString to be transmitted

Definition at line 32 of file HTTPText.cpp.

HTTPText ( char *  str,
size_t  size 
)

Create an HTTPText instance for input.

Parameters:
strBuffer to store the incoming string
sizeSize of the buffer

Definition at line 37 of file HTTPText.cpp.

Member Function Documentation

size_t getDataLen (  ) [protected, virtual]

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

Implements IHTTPDataOut.

Definition at line 72 of file HTTPText.cpp.

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

Get MIME type.

Parameters:
typeInternet media type from Content-Type header

Implements IHTTPDataOut.

Definition at line 56 of file HTTPText.cpp.

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

Get a specific header.

Definition at line 33 of file IHTTPData.h.

bool getIsChunked (  ) [protected, virtual]

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

Implements IHTTPDataOut.

Definition at line 67 of file HTTPText.cpp.

int read ( char *  buf,
size_t  len,
size_t *  pReadLen 
) [protected, 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

Implements IHTTPDataOut.

Definition at line 48 of file HTTPText.cpp.

void readReset (  ) [protected, virtual]

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

Implements IHTTPDataOut.

Definition at line 43 of file HTTPText.cpp.

void setDataLen ( size_t  len ) [protected, virtual]

If the data is not chunked, set its size From Content-Length header.

Implements IHTTPDataIn.

Definition at line 102 of file HTTPText.cpp.

void setDataType ( const char *  type ) [protected, virtual]

Set MIME type.

Parameters:
typeInternet media type from Content-Type header

Implements IHTTPDataIn.

Definition at line 92 of file HTTPText.cpp.

void setIsChunked ( bool  chunked ) [protected, virtual]

Determine whether the data is chunked Recovered from Transfer-Encoding header.

Implements IHTTPDataIn.

Definition at line 97 of file HTTPText.cpp.

int write ( const char *  buf,
size_t  len 
) [protected, virtual]

Write a piece of data transmitted by the server.

Parameters:
bufPointer to the buffer from which to copy the data
lenLength of the buffer

Implements IHTTPDataIn.

Definition at line 83 of file HTTPText.cpp.

void writeReset (  ) [protected, virtual]

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

Implements IHTTPDataIn.

Definition at line 78 of file HTTPText.cpp.

Generated on Tue Jul 12 2022 18:13:35 by  doxygen 1.7.2