FreeRTOS: HTTPS Client
HTTPS Client v1.0.0 library
Return to main page ↑
Related Pages
Here is a list of all related documentation pages:
[detail level 12]
 DesignArchitecture behind the HTTPS library
 DemosThe HTTPS Client demos demonstrates usage of the HTTPS Client library
 Download Demo Usage Instructions
 Upload Demo Usage Instructions
 Demo ConfigurationConfiguration settings of the HTTP Client demo.
Configuration settings are C pre-processor constants. They can be set with a #define in the iot_config.h or by using a compiler option such as -D in gcc. If a configuration setting is not defined, the library will use a "sensible" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed.

The settings on this page only affect the HTTP Client demo. In addition to the settings on this page, the HTTP Client demo will also be affected by settings that affect all demos
 TestsTests written for the HTTPS Client library
 Test ConfigurationConfiguration settings of the HTTPS Client tests.
Configuration settings are C pre-processor constants. They can be set with a #define in the iot_config.h or by using a compiler option such as -D in gcc. If a configuration setting is not defined, the library will use a "sensible" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed.

The settings on this page only affect the HTTPS Client tests. In addition to the settings on this page, the HTTPS Client tests will also be affected by settings that affect all tests
 ConfigurationConfiguration settings of the HTTPS Client library.
Configuration settings are C pre-processor constants. They can be set with a #define in the iot_config.h or by using a compiler option such as -D in gcc. If a configuration setting is not defined, the library will use a "sensible" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed
 FunctionsFunctions of the https_client library.

The https_client library consists of the following functions
 IotHttpsClient_InitOne-time initialization of the IoT HTTPS Client library.
 IotHttpsClient_CleanupOne time clean up of the IoT HTTPS Client library.
 IotHttpsClient_DisconnectDisconnect from the HTTPS server given the connection handle connHandle.
 IotHttpsClient_ConnectExplicitly connect to the HTTPS server given the connection configuration pConnConfig.
 IotHttpsClient_InitializeRequestInitializes the request by adding a formatted Request-Line to the start of HTTPS request header buffer.
 IotHttpsClient_AddHeaderAdd a header to the current HTTPS request represented by reqHandle.
 IotHttpsClient_WriteRequestBodyWrites the request body to the network for the request represented by reqHandle.
 IotHttpsClient_SendSyncSynchronous send of the HTTPS request.
 IotHttpsClient_SendAsyncAsynchronous send of the the HTTPS request.
 IotHttpsClient_CancelRequestAsyncCancel an Asynchronous request.
 IotHttpsClient_CancelResponseAsyncCancel an Asynchronous response.
 IotHttpsClient_ReadResponseStatusRetrieve the HTTPS response status.
 IotHttpsClient_ReadContentLengthRetrieve the HTTPS response content length.
 IotHttpsClient_ReadHeaderRetrieve the header of interest from the response represented by respHandle.
 IotHttpsClient_ReadResponseBodyRead the HTTPS response body from the network.
 ConstantsDefined constants of the HTTPS Client library.

Libraries may #define constants in their headers with special meanings. This page describes the meanings and uses of any constants defined by the HTTPS Client library. Related constants are shown in a single section on this page.