Asynchronous send of the the HTTPS request.

IotHttpsReturnCode_t IotHttpsClient_SendAsync( IotHttpsConnectionHandle_t connHandle,
                                               IotHttpsRequestHandle_t reqHandle,
                                               IotHttpsResponseHandle_t * pRespHandle,
                                               IotHttpsResponseInfo_t * pRespInfo );

This function will invoke, as needed, each of the non-NULL callbacks configured in IotHttpsAsyncInfo_t.callbacks when the scheduled asynchronous request is progress. Please see IotHttpsClientCallbacks_t for information on each of the callbacks.

After this API is executed, the scheduled async response will store the response headers as received from the network, in the header buffer space configured in IotHttpsResponseInfo_t.userBuffer. If the configured IotHttpsResponseInfo_t.userBuffer is too small to fit the headers received, then headers that don't fit will be thrown away. Please see responseUserBufferMinimumSize for information about sizing the IotHttpsResponseInfo_t.userBuffer.

If IotHttpsRequestInfo_t.isNonPersistent is set to true, then the connection will disconnect, close, and clean all taken resources automatically after receiving the first response.

See connectionUserBufferMinimumSize for information about the user buffer configured in IotHttpsConnectionInfo_t.userBuffer needed to create a valid connection handle.

A IotHttpsRequestHandle_t cannot be schedule again or reused until the request has finished sending. The request has safely finished sending once IotHttpsClientCallbacks_t.readReadyCallback is invoked. After the IotHttpsClientCallbacks_t.readReadyCallback is invoked the IotHttpsRequestInfo_t.userBuffer can freed, modified, or reused.

Parameters

[in]	connHandle	- Handle from an HTTPS connection.
[in]	reqHandle	- Handle from a request created with IotHttpsClient_initialize_request.
[out]	pRespHandle	- HTTPS response handle.
[in]	pRespInfo	- HTTP response configuration information.

Returns

One of the following:

IOT_HTTPS_OK if the request was sent and the response was received successfully.
IOT_HTTPS_MESSAGE_TOO_LARGE if the response cannot fit in the configured IotHttpsRequestHandle_t.response_message.headers and IotHttpsRequestHandle_t.response_message.body.
IOT_HTTPS_CONNECTION_ERROR if the connection failed.
IOT_HTTPS_FATAL if there was a grave error with the last async job finishing.
IOT_HTTPS_ASYNC_SCHEDULING_ERROR if there was an error scheduling the asynchronous request.
IOT_HTTPS_INTERNAL_ERROR if there was an internal error with starting an asynchronous request servicing task.
IOT_HTTPS_INVALID_PARAMETER if there were NULL parameters or the request passed in was a synchronous type.