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

Context to the HTTP asynchronous workflow callbacks to verify operation. More...

Data Fields

IotSemaphore_t completeSem
 Semaphore to signal to the test that the asynchronous requests have all finished.
 
uint8_t numRequestsTotal
 The starting total of scheduled request.
 
int8_t numRequestsLeft
 The number of scheduled requests left that have not finished.
 
uint8_t appendHeaderCallbackCount
 A count of the times IotHttpsClientCallbacks_t.appendHeaderCallback has been called.
 
uint8_t writeCallbackCount
 A count of the times IotHttpsClientCallbacks_t.writeCallback has been called.
 
uint8_t readReadyCallbackCount
 A count of the times IotHttpsClientCallbacks_t.readReadyCallback has been called.
 
uint8_t responseCompleteCallbackCount
 A count of the times IotHttpsClientCallbacks_t.responseCompleteCallback has been called.
 
uint8_t connectionClosedCallbackCount
 A count of the times IotHttpsClientCallbacks_t.connectionClosedCallback has been called.
 
uint8_t errorCallbackCount
 A count of the times IotHttpsClientCallbacks_t.errorCallback has been called.
 
IotHttpsReturnCode_t returnCode [HTTPS_TEST_MAX_ASYNC_REQUESTS]
 The final return status of the async request. This is set during each decrement of numRequestsLeft.
 
uint8_t readReadyCallbackCountPerResponse [HTTPS_TEST_MAX_ASYNC_REQUESTS]
 readReadyCallback invocation count per response. More...
 
IotSemaphore_t finishedSem
 This semaphore is posted to when the asynchronous response is finished.
 
uint16_t responseStatus
 The HTTP response status code in the current asynchronous request.
 
uint32_t contentLength
 The HTTP response body Content-Length the current asynchronous request.
 
IotHttpsReturnCode_t contentLengthReturnCode
 
uint32_t bodyReceivedLength
 The amount of HTTP response body read from the network.
 
IotHttpsReturnCode_t readResponseBodyReturnCode
 The HTTP Client library return code from reading HTTP response body from the network.
 

Detailed Description

Context to the HTTP asynchronous workflow callbacks to verify operation.

These parameters get set during the asynchronous test to verify.

Field Documentation

◆ readReadyCallbackCountPerResponse

uint8_t _asyncVerificationParams_t::readReadyCallbackCountPerResponse[HTTPS_TEST_MAX_ASYNC_REQUESTS]

readReadyCallback invocation count per response.

This is needed for verification of the body. The readReadyCallback is invoked a second time for the same response because there is more data in the body that could fit in the provided buffer. In this case we want to verify the correct body of 'a'-'z' repeating starting from where verification left off last. When it is a new request verification starts at 0 or 'a'.

◆ contentLengthReturnCode

IotHttpsReturnCode_t _asyncVerificationParams_t::contentLengthReturnCode

The HTTPS Client library return code from trying to read the Content-Length value.


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