FreeRTOS: HTTPS Client
HTTPS Client v1.0.0 library
Return to main page ↑
IotHttpsResponseInfo_t Struct Reference

HTTP request configuration. More...

#include <iot_https_types.h>

Data Fields

IotHttpsUserBuffer_t userBuffer
 
IotHttpsSyncInfo_tpSyncInfo
 Specific information for a synchronously received response. More...
 

Detailed Description

HTTP request configuration.

Parameter for: IotHttpsClient_SendSync and IotHttpsClient_SendAsync

A separate response info is defined so that the application can re-initialize a request for re-use while still processing a response that was already completed.

Field Documentation

◆ userBuffer

IotHttpsUserBuffer_t IotHttpsResponseInfo_t::userBuffer

The application owned buffer for storing the response headers and internal response context.

For an asynchronous request, if the application owns the memory for this buffer, then it must not be modified, freed, or reused until the the IotHttpsClientCallbacks_t.responseCompleteCallback is invoked.

Please see IotHttpsUserBuffer_t for more information.

◆ pSyncInfo

IotHttpsSyncInfo_t* IotHttpsResponseInfo_t::pSyncInfo

Specific information for a synchronously received response.

Set this to NULL if the response is to be received asynchronously.

See IotHttpsSyncInfo_t for more information.


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