|
FreeRTOS:
HTTPS Client
HTTPS Client v1.0.0 library
|
| Return to main page ↑ |
| Design | Architecture behind the HTTPS library |
| ▼Demos | The HTTPS Client demos demonstrates usage of the HTTPS Client library |
| Download Demo Usage Instructions | |
| Upload Demo Usage Instructions | |
| Demo Configuration | Configuration settings of the HTTP Client demo. Configuration settings are C pre-processor constants. They can be set with a # 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 |
| ▼Tests | Tests written for the HTTPS Client library |
| Test Configuration | Configuration settings of the HTTPS Client tests. Configuration settings are C pre-processor constants. They can be set with a # 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 |
| Configuration | Configuration settings of the HTTPS Client library. Configuration settings are C pre-processor constants. They can be set with a # 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 |
| ▼Functions | Functions of the https_client library. The https_client library consists of the following functions |
| IotHttpsClient_Init | One-time initialization of the IoT HTTPS Client library. |
| IotHttpsClient_Cleanup | One time clean up of the IoT HTTPS Client library. |
| IotHttpsClient_Disconnect | Disconnect from the HTTPS server given the connection handle connHandle. |
| IotHttpsClient_Connect | Explicitly connect to the HTTPS server given the connection configuration pConnConfig. |
| IotHttpsClient_InitializeRequest | Initializes the request by adding a formatted Request-Line to the start of HTTPS request header buffer. |
| IotHttpsClient_AddHeader | Add a header to the current HTTPS request represented by reqHandle. |
| IotHttpsClient_WriteRequestBody | Writes the request body to the network for the request represented by reqHandle. |
| IotHttpsClient_SendSync | Synchronous send of the HTTPS request. |
| IotHttpsClient_SendAsync | Asynchronous send of the the HTTPS request. |
| IotHttpsClient_CancelRequestAsync | Cancel an Asynchronous request. |
| IotHttpsClient_CancelResponseAsync | Cancel an Asynchronous response. |
| IotHttpsClient_ReadResponseStatus | Retrieve the HTTPS response status. |
| IotHttpsClient_ReadContentLength | Retrieve the HTTPS response content length. |
| IotHttpsClient_ReadHeader | Retrieve the header of interest from the response represented by respHandle. |
| IotHttpsClient_ReadResponseBody | Read the HTTPS response body from the network. |
| Constants | Defined constants of the HTTPS Client library. Libraries may # 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. |