FreeRTOS
Data Fields
MQTTConnectParams Struct Reference

MQTT Connect Parameters. More...

#include <aws_mqtt_lib.h>

Data Fields

uint16_t usKeepAliveIntervalSeconds
 
uint32_t ulKeepAliveActualIntervalTicks
 
uint32_t ulPingRequestTimeoutTicks
 
const uint8_t * pucClientId
 
uint16_t usClientIdLength
 
const uint8_t * pucUserName
 
uint16_t usUserNameLength
 
uint16_t usPacketIdentifier
 
uint32_t ulTimeoutTicks
 

Detailed Description

MQTT Connect Parameters.

Parameters passed to the MQTT_Connect API.

Definition at line 517 of file aws_mqtt_lib.h.

Field Documentation

◆ pucClientId

const uint8_t* pucClientId

Client Id identifies the client to the server. Must be unique per broker.

Definition at line 522 of file aws_mqtt_lib.h.

◆ pucUserName

const uint8_t* pucUserName

The user name.

Definition at line 524 of file aws_mqtt_lib.h.

◆ ulKeepAliveActualIntervalTicks

uint32_t ulKeepAliveActualIntervalTicks

The time interval in ticks after which a keep alive message should be sent. Note that keep alive messages are sent only if nothing else is sent.

Definition at line 520 of file aws_mqtt_lib.h.

◆ ulPingRequestTimeoutTicks

uint32_t ulPingRequestTimeoutTicks

The time interval in ticks to wait for PINGRESP after sending PINGREQ.

Definition at line 521 of file aws_mqtt_lib.h.

◆ ulTimeoutTicks

uint32_t ulTimeoutTicks

The time interval in ticks after which the operation should fail.

Definition at line 527 of file aws_mqtt_lib.h.

◆ usClientIdLength

uint16_t usClientIdLength

The length of the client Id.

Definition at line 523 of file aws_mqtt_lib.h.

◆ usKeepAliveIntervalSeconds

uint16_t usKeepAliveIntervalSeconds

The maximum time interval (in seconds) permitted to elapse between two control packets transmitted.

Definition at line 519 of file aws_mqtt_lib.h.

◆ usPacketIdentifier

uint16_t usPacketIdentifier

The same identifier is returned in the callback when corresponding CONNACK is received or the operation times out.

Definition at line 526 of file aws_mqtt_lib.h.

◆ usUserNameLength

uint16_t usUserNameLength

The length of the user name.

Definition at line 525 of file aws_mqtt_lib.h.


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