Constants

Defined 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.

HTTPS Client Minimum User Buffer Sizes

Variables calculating the size of IotHttpsUserBuffer_t.bufferLen needed for the request, response, and connection.

Note

These user buffer minimum values may change at any time in future versions, but their names will remain the same.

• requestUserBufferMinimumSize
  Minimum size of the request user buffer.
• responseUserBufferMinimumSize
  Minimum size of the response user buffer.
• connectionUserBufferMinimumSize
  Minimum size of the connection user buffer.

HTTPS Client Connection Flags

Flags that modify the behavior of the HTTPS Connection.

Flags should be bitwise-ORed with each other to change the behavior of IotHttpsClient_SendAsync and IotHttpsClient_SendSync. These flags are set in IotHttpsConnectionInfo_t.flags.

Note

The values of flags may change at any time in future versions, but their names will remain the same.

HTTP Initializers

Provide default values for the data types of the HTTP Client Library.

 
#define IOT_HTTPS_CONNECTION_HANDLE_INITIALIZER    NULL
 
#define IOT_HTTPS_REQUEST_HANDLE_INITIALIZER       NULL
 
#define IOT_HTTPS_RESPONSE_HANDLE_INITIALIZER      NULL
 
#define IOT_HTTPS_USER_BUFFER_INITIALIZER          { 0 }
 
#define IOT_HTTPS_SYNC_INFO_INITIALIZER            { 0 }
 
#define IOT_HTTPS_ASYNC_INFO_INITIALIZER           { 0 }
 
#define IOT_HTTPS_CONNECTION_INFO_INITIALIZER      { 0 }
 
#define IOT_HTTPS_REQUEST_INFO_INITIALIZER         { 0 }
 
#define IOT_HTTPS_RESPONSE_INFO_INITIALIZER        { 0 }

All user-facing data types of the HTTPS Client library should be initialized using one of the following.

Warning

Failing to initialize an HTTPS Client data type with the appropriate initializer may result in undefined behavior.

Note

The initializers may change at any time in future versions, but their names will remain the same.

Example

IotHttpsConnectionHandle_t connHandle = IOT_HTTPS_CONNECTION_HANDLE_INITIALIZER;
IotHttpsRequestHandle_t reqHandle = IOT_HTTPS_REQUEST_HANDLE_INITIALIZER;
IotHttpsResponseHandle_t respHandle = IOT_HTTPS_RESPONSE_HANDLE_INITIALIZER;
IotHttpsUserBuffer_t userBuffer = IOT_HTTPS_USER_BUFFER_INITIALIZER;
IotHttpsSyncInfo_t syncInfoReq = IOT_HTTPS_SYNC_INFO_INITIALIZER;
IotHttpsSyncInfo_t syncInfoResp = IOT_HTTPS_SYNC_INFO_INITIALIZER;
IotHttpsConnectionInfo_t connInfo = IOT_HTTPS_CONNECTION_INFO_INITIALIZER;
IotHttpsRequestInfo_t reqInfo = IOT_HTTPS_REQUEST_INFO_INITIALIZER
IotHttpsResponseInfo_t respInfo = IOT_HTTPS_RESPONSE_INFO_INITIALIZER

HTTPS Client Connection Flags

Flags that modify the behavior the HTTPS connection.

• IOT_HTTPS_IS_NON_TLS_FLAG
  Flag for IotHttpsConnectionInfo_t that disables TLS.
• IOT_HTTPS_DISABLE_SNI
  Flag for IotHttpsConnectionInfo_t that disables Server Name Indication (SNI).