IotNetworkCredentials Struct Reference

Contains the credentials necessary for connection setup. More...

#include <iot_network.h>

Data Fields
const char *	pAlpnProtos
	Set this to a non-NULL value to use ALPN. More...
size_t	maxFragmentLength
	Set this to a non-zero value to use TLS max fragment length negotiation (TLS MFLN). More...
bool	disableSni
	Disable server name indication (SNI) for a TLS session.
const char *	pRootCa
	String representing a trusted server root certificate.
size_t	rootCaSize
	Size associated with IotNetworkCredentials.pRootCa.
const char *	pClientCert
	String representing the client certificate.
size_t	clientCertSize
	Size associated with IotNetworkCredentials.pClientCert.
const char *	pPrivateKey
	String representing the client certificate's private key.
size_t	privateKeySize
	Size associated with IotNetworkCredentials.pPrivateKey.
const char *	pUserName
	String representing the username for MQTT.
size_t	userNameSize
	Size associated with IotNetworkCredentials.pUserName.
const char *	pPassword
	String representing the password for MQTT.
size_t	passwordSize
	Size associated with IotNetworkCredentials.pPassword.

Detailed Description

Contains the credentials necessary for connection setup.

May be passed to IotNetworkInterface_t.create as pCredentialInfo. This structure contains commonly-used parameters, but may be replaced with an alternative.

Field Documentation

pAlpnProtos

const char* IotNetworkCredentials::pAlpnProtos

Set this to a non-NULL value to use ALPN.

This string must be NULL-terminated.

See this link for more information.

maxFragmentLength

size_t IotNetworkCredentials::maxFragmentLength

Set this to a non-zero value to use TLS max fragment length negotiation (TLS MFLN).

Note

The network stack may have a minimum value for this parameter and may return an error if this parameter is too small.

---

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

• iot_network.h