Parameters passed to the MQTT_AGENT_Connect API. More...

#include <aws_mqtt_agent.h>

Data Fields
const char *	pcURL

BaseType_t	xFlags

BaseType_t	xURLIsIPAddress

uint16_t	usPort

const uint8_t *	pucClientId

uint16_t	usClientIdLength

BaseType_t	xSecuredConnection

void *	pvUserData

MQTTAgentCallback_t	pxCallback

char *	pcCertificate

uint32_t	ulCertificateSize

Detailed Description

Parameters passed to the MQTT_AGENT_Connect API.

Definition at line 135 of file aws_mqtt_agent.h.

Field Documentation

◆ pcCertificate

char* pcCertificate

Certificate used for secure connection. Can be NULL. If it is NULL, the one specified in the aws_credential_keys.h is used.

Definition at line 147 of file aws_mqtt_agent.h.

◆ pcURL

const char* pcURL

The URL of the MQTT broker to connect to.

Definition at line 137 of file aws_mqtt_agent.h.

◆ pucClientId

const uint8_t* pucClientId

Client Identifier of the MQTT client. It should be unique per broker.

Definition at line 141 of file aws_mqtt_agent.h.

◆ pvUserData

void* pvUserData

User data supplied back as it is in the callback. Can be NULL.

Definition at line 144 of file aws_mqtt_agent.h.

◆ pxCallback

MQTTAgentCallback_t pxCallback

Callback used to report various events. In addition to other events, this callback is invoked for the publish messages received on the topics for which the user has not registered any subscription callback. Can be NULL.

Definition at line 145 of file aws_mqtt_agent.h.

◆ ulCertificateSize

uint32_t ulCertificateSize

Size of certificate used for secure connection.

Definition at line 148 of file aws_mqtt_agent.h.

◆ usClientIdLength

uint16_t usClientIdLength

The length of the client Id.

Definition at line 142 of file aws_mqtt_agent.h.

◆ usPort

uint16_t usPort

Port number at which MQTT broker is listening. This field is ignored if the mqttagentUSE_AWS_IOT_ALPN_443 flag is set.

Definition at line 140 of file aws_mqtt_agent.h.

◆ xFlags

BaseType_t xFlags

Flags to control the behavior of MQTT connect.

Definition at line 138 of file aws_mqtt_agent.h.

◆ xSecuredConnection

BaseType_t xSecuredConnection

Deprecated. Set the mqttagentREQUIRE_TLS bit in xFlags instead.

Definition at line 143 of file aws_mqtt_agent.h.

◆ xURLIsIPAddress

BaseType_t xURLIsIPAddress

Deprecated. Set the mqttagentURL_IS_IP_ADDRESS bit in xFlags instead.

Definition at line 139 of file aws_mqtt_agent.h.

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

C:/AFR/freertos-master/lib/include/aws_mqtt_agent.h

Data Fields