IotHttpsConnectionInfo_t Struct Reference

HTTP connection configuration. More...

#include <iot_https_types.h>

Data Fields
const char *	pAddress
	Remote server address that is DNS discoverable. More...
uint32_t	addressLen
	remote address length.
uint16_t	port
	Remote port number.
uint32_t	flags
	Flags to configure the HTTPS connection. More...
uint32_t	timeout
	Timeout waiting for a response from the network in milliseconds. More...
const char *	pCaCert
	Server trusted certificate store for this connection.
uint32_t	caCertLen
	Server trusted certificate store size.
const char *	pClientCert
	Client certificate store for this connection.
uint32_t	clientCertLen
	Client certificate store size.
const char *	pPrivateKey
	Client private key store for this connection.
uint32_t	privateKeyLen
	Client private key store size.
char *	pAlpnProtocols
	String of all the ALPN protocols separated by commas needed for this connection. More...
uint32_t	alpnProtocolsLen
	ALPN protocol string length.
IotHttpsUserBuffer_t	userBuffer
	User buffer to store the internal connection context. More...
IOT_HTTPS_NETWORK_INTERFACE_TYPE	pNetworkInterface
	The IOT network abstraction interface. More...

Detailed Description

HTTP connection configuration.

Parameter for: IotHttpsClient_Connect or IotHttpsClient_SendSync or IotHttpsClient_SendAsync.

This parameter is used to connection in IotHttpsClient_Connect.

Note

The lengths of the strings in this struct should not include the NULL terminator. Strings in this struct do not need to be NULL-terminated.

Field Documentation

pAddress

const char* IotHttpsConnectionInfo_t::pAddress

Remote server address that is DNS discoverable.

For example: avs-alexa-na.amazon.com.

flags

uint32_t IotHttpsConnectionInfo_t::flags

Flags to configure the HTTPS connection.

See HTTPS Client Connection Flags for the available flags.

Unknown flags are ignored.

Flags to configure the HTTPS connection.

timeout

uint32_t IotHttpsConnectionInfo_t::timeout

Timeout waiting for a response from the network in milliseconds.

If this is set to zero, it will default to IOT_HTTPS_RESPONSE_WAIT_MS.

pAlpnProtocols

char* IotHttpsConnectionInfo_t::pAlpnProtocols

String of all the ALPN protocols separated by commas needed for this connection.

For the protocols needed for the AWS Iot Message broker endpoint please see: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html

userBuffer

IotHttpsUserBuffer_t IotHttpsConnectionInfo_t::userBuffer

User buffer to store the internal connection context.

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

pNetworkInterface

IOT_HTTPS_NETWORK_INTERFACE_TYPE IotHttpsConnectionInfo_t::pNetworkInterface

The IOT network abstraction interface.

This contains the interface to connect, disconnect, send data, and receive data from the network.

In FreeRTOS this should be of the type IotNetworkInterface_t.

---

The documentation for this struct was generated from the following file:

• iot_https_types.h