Represents one connection to an MQTT broker. More...

#include <aws_mqtt_lib.h>

Data Fields
Link_t	xTxBufferListHead

MQTTBufferHandle_t	xRxBuffer

MQTTRxMessageState_t	xRxMessageState

uint8_t	ucRxFixedHeaderBuffer [mqttFIXED_HEADER_MAX_SIZE]

uint32_t	ulRxMessageReceivedLength

void *	pvCallbackContext

MQTTEventCallback_t	pxCallback

void *	pvSendContext

MQTTSend_t	pxMQTTSendFxn

MQTTGetTicks_t	pxGetTicksFxn

MQTTBufferPoolInterface_t	xBufferPoolInterface

MQTTConnectionState_t	xConnectionState

uint64_t	xLastSentMessageTimestamp

uint32_t	ulNextPeriodicInvokeTicks

uint32_t	ulKeepAliveActualIntervalTicks

uint32_t	ulPingRequestTimeoutTicks

MQTTBool_t	xWaitingForPingResp

Detailed Description

Represents one connection to an MQTT broker.

A context should be initialized using MQTT_Init before it can be used in the subsequent function calls.

Definition at line 473 of file aws_mqtt_lib.h.

Field Documentation

◆ pvCallbackContext

void* pvCallbackContext

As supplied by the user in Init parameters.

Definition at line 480 of file aws_mqtt_lib.h.

◆ pvSendContext

void* pvSendContext

As supplied by the user in Init parameters.

Definition at line 482 of file aws_mqtt_lib.h.

◆ pxCallback

MQTTEventCallback_t pxCallback

Callback supplied by the user to get notified of various events.

Definition at line 481 of file aws_mqtt_lib.h.

◆ pxGetTicksFxn

MQTTGetTicks_t pxGetTicksFxn

Callback supplied by the user to get current tick count.

Definition at line 484 of file aws_mqtt_lib.h.

◆ pxMQTTSendFxn

MQTTSend_t pxMQTTSendFxn

Callback supplied by the user to transmit data.

Definition at line 483 of file aws_mqtt_lib.h.

◆ ucRxFixedHeaderBuffer

uint8_t ucRxFixedHeaderBuffer[mqttFIXED_HEADER_MAX_SIZE]

The buffer used to store the fixed header of the incoming message.

Definition at line 478 of file aws_mqtt_lib.h.

◆ ulKeepAliveActualIntervalTicks

uint32_t ulKeepAliveActualIntervalTicks

The time interval in ticks after which a keep alive message should be sent.

Definition at line 489 of file aws_mqtt_lib.h.

◆ ulNextPeriodicInvokeTicks

uint32_t ulNextPeriodicInvokeTicks

The time interval in ticks after which MQTT_Periodic function must be called.

Definition at line 488 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 490 of file aws_mqtt_lib.h.

◆ ulRxMessageReceivedLength

uint32_t ulRxMessageReceivedLength

The length of the message received so far.

Definition at line 479 of file aws_mqtt_lib.h.

◆ xBufferPoolInterface

MQTTBufferPoolInterface_t xBufferPoolInterface

The buffer pool interface supplied by the user.

See also: MQTTBufferPoolInterface_t.

Definition at line 485 of file aws_mqtt_lib.h.

◆ xConnectionState

MQTTConnectionState_t xConnectionState

The current connection state.

Definition at line 486 of file aws_mqtt_lib.h.

◆ xLastSentMessageTimestamp

uint64_t xLastSentMessageTimestamp

The timestamp when the last message (or acknowledgment) was sent.

Definition at line 487 of file aws_mqtt_lib.h.

◆ xRxBuffer

MQTTBufferHandle_t xRxBuffer

The Rx buffer i.e. the buffer used to store the incoming message.

Definition at line 476 of file aws_mqtt_lib.h.

◆ xRxMessageState

MQTTRxMessageState_t xRxMessageState

The state of the message being received currently.

Definition at line 477 of file aws_mqtt_lib.h.

◆ xTxBufferListHead

Link_t xTxBufferListHead

The list of Tx buffers i.e. buffers containing transmitted messages waiting for ACK.

Definition at line 475 of file aws_mqtt_lib.h.

◆ xWaitingForPingResp

MQTTBool_t xWaitingForPingResp

Whether a keep alive message has been sent and we are waiting for response from the broker.

Definition at line 491 of file aws_mqtt_lib.h.

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

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

Data Fields