IotHttpsClient_WriteRequestBody

Writes the request body to the network for the request represented by reqHandle.

IotHttpsReturnCode_t IotHttpsClient_WriteRequestBody( IotHttpsRequestHandle_t reqHandle,
                                                      uint8_t * pBuf,
                                                      uint32_t len,
                                                      int isComplete );

This function is intended to be used by an asynchronous request. It must be called within the IotHttpsClientCallbacks_t.writeCallback.

In HTTP/1.1 the headers are sent on the network first before any body can be sent. The auto-generated header Content-Length is taken from the len parameter and sent first before the data in parameter pBuf is sent. This library does not support Transfer-Encoding: chunked or other requests where the Content-Length is unknown, so this function cannot be called more than once in IotHttpsClientCallbacks_t.writeCallback for an HTTP/1.1 request.

isComplete must always be set to 1 in this current version of the HTTPS client library.

If there are network errors in sending the HTTP headers, then the IotHttpsClientCallbacks_t.errorCallback will be invoked following a return from the IotHttpsClientCallbacks_t.writeCallback.

Example Asynchronous Code

void applicationDefined_writeCallback(void * pPrivData, IotHttpsRequestHandle_t reqHandle)
{
     ...
     char * writeData[1024];
     IotHttpsClient_WriteRequestBody(reqHandle, writeData, 1024, 1);
     ...
}

Parameters

[in]	reqHandle	- identifier of the connection.
[in]	pBuf	- client write data buffer pointer.
[in]	len	- length of data to write.
[in]	isComplete	- This parameter parameter must be set to 1.

Returns

one of the following:

• IOT_HTTPS_OK if write successfully, failure code otherwise.
• IOT_HTTPS_MESSAGE_FINISHED if this function is called a second time with the same reqHandle.
• IOT_HTTPS_NOT_SUPPORTED if isComplete is set to 0.
• IOT_HTTPS_INVALID_PARAMETER if this API is used for a synchronous request.
• IOT_HTTPS_NETWORK_ERROR if there was an error sending the headers or body on the network.
• Please see IotHttpsReturnCode_t for other failure codes.