Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: Sample_HTTPClient Sample_HTTPClient LWM2M_NanoService_Ethernet LWM2M_NanoService_Ethernet ... more
Fork of
HTTPClient
by 
Vincent Wochnik
HTTPText Class Reference
A data endpoint to store text. More...
#include <HTTPText.h>
Inherits IHTTPDataIn, and IHTTPDataOut.
Inherited by HTTPJson.
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. | |
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:
-
[in] str String to be transmitted
Definition at line 32 of file HTTPText.cpp.
| HTTPText | ( | char * | str, |
| size_t | size | ||
| ) |
Create an HTTPText instance for input.
- Parameters:
-
[in] str Buffer to store the incoming string [in] size Size 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 68 of file HTTPText.cpp.
| int getDataType | ( | char * | type, |
| size_t | maxTypeLen | ||
| ) | [protected, virtual] |
Get MIME type.
- Parameters:
-
[out] type Internet media type from Content-Type header [in] maxTypeLen is the size of the type buffer to write to
Implements IHTTPDataOut.
Reimplemented in HTTPJson.
Definition at line 56 of file HTTPText.cpp.
| bool getIsChunked | ( | ) | [protected, virtual] |
Determine whether the HTTP client should chunk the data Used for Transfer-Encoding header.
Implements IHTTPDataOut.
Definition at line 63 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:
-
[out] buf Pointer to the buffer on which to copy the data [in] len Length of the buffer [out] pReadLen Pointer 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 98 of file HTTPText.cpp.
| void setDataType | ( | const char * | type ) | [protected, virtual] |
Set MIME type.
- Parameters:
-
type Internet media type from Content-Type header
Implements IHTTPDataIn.
Definition at line 88 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 93 of file HTTPText.cpp.
| int write | ( | const char * | buf, |
| size_t | len | ||
| ) | [protected, virtual] |
Write a piece of data transmitted by the server.
- Parameters:
-
buf Pointer to the buffer from which to copy the data len Length of the buffer
Implements IHTTPDataIn.
Definition at line 79 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 74 of file HTTPText.cpp.
Generated on Tue Jul 12 2022 17:30:36 by
1.7.2