FreeRTOS
Data Fields
MQTTSubscribeParams Struct Reference

MQTT Subscribe Parameters. More...

#include <aws_mqtt_lib.h>

Data Fields

const uint8_t * pucTopic
 
uint16_t usTopicLength
 
MQTTQoS_t xQos
 
uint16_t usPacketIdentifier
 
uint32_t ulTimeoutTicks
 

Detailed Description

MQTT Subscribe Parameters.

Parameters passed to the MQTT_Subscribe API.

Definition at line 535 of file aws_mqtt_lib.h.

Field Documentation

◆ pucTopic

const uint8_t* pucTopic

The topic to subscribe to. This can be a topic filter containing wild cards as permitted by the MQTT protocol.

Definition at line 537 of file aws_mqtt_lib.h.

◆ ulTimeoutTicks

uint32_t ulTimeoutTicks

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

Definition at line 541 of file aws_mqtt_lib.h.

◆ usPacketIdentifier

uint16_t usPacketIdentifier

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

Definition at line 540 of file aws_mqtt_lib.h.

◆ usTopicLength

uint16_t usTopicLength

The length of the topic.

Definition at line 538 of file aws_mqtt_lib.h.

◆ xQos

MQTTQoS_t xQos

Requested Quality of Service (QoS).

Definition at line 539 of file aws_mqtt_lib.h.


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