IotHttpsSyncInfo_t Struct Reference

HTTPS Client synchronous request information. More...

#include <iot_https_types.h>

Data Fields
uint8_t *	pBody
uint32_t	bodyLen
	The length of the HTTP message body.

Detailed Description

HTTPS Client synchronous request information.

Parameter for: IotHttpsClient_InitializeRequest, IotHttpsClient_SendSync, IotHttpsClient_SendAsync

This structure is configured in IotHttpsRequestInfo_t.u and IotHttpsResponseInfo_t.

A synchronous request will block until the response is fully received from the network. This structure defines memory locations to store the response body.

Field Documentation

pBody

uint8_t* IotHttpsSyncInfo_t::pBody

Pointer to the HTTP message body.

For a request this is the file or data we want to send. The data is separated from the headers for the flexibility to point to an already established file elsewhere in memory.

For a response this is where to receive the response entity body. If the length of the buffer provided to store the response body is smaller than the amount of body received, then IotHttpsClient_SendSync will return a IOT_HTTPS_INSUFFICIENT_MEMORY error code. Although an error was returned, the first IotHttpsSyncInfo_t.bodyLen of the response received on the network will still be available in the buffer.

---

The documentation for this struct was generated from the following file:

• iot_https_types.h