_MqttSnClientContext Struct Reference

MQTT-SN client context. More...

#include <mqtt_sn_client.h>

Data Fields

MqttSnClientState state
 MQTT-SN client state. More...
MqttSnTransportProtocol transportProtocol
 Transport protocol (UDP or DTLS) More...
const MqttSnPredefinedTopicpredefinedTopicTable
 List of predefined topics. More...
uint_t predefinedTopicTableSize
 Number of predefined topics. More...
systime_t timeout
 Timeout value. More...
systime_t keepAlive
 Keep-alive interval. More...
char_t clientId [MQTT_SN_CLIENT_MAX_ID_LEN+1]
 Client identifier. More...
MqttSnClientWillMessage willMessage
 Will message. More...
 Underlying network interface. More...
 Underlying TCP socket. More...
 DTLS context. More...
TlsSessionState dtlsSession
 DTLS session state. More...
MqttSnClientDtlsInitCallback dtlsInitCallback
 DTLS initialization callback. More...
MqttSnClientPublishCallback publishCallback
 PUBLISH message received callback. More...
IpAddr gwIpAddr
 Gateway IP address. More...
uint16_t gwPort
 Gateway port number. More...
systime_t startTime
 Start time. More...
systime_t retransmitStartTime
 Time at which the last message was sent. More...
systime_t retransmitTimeout
 Retransmission timeout. More...
systime_t keepAliveTimestamp
 Timestamp used to manage keep-alive. More...
uint_t keepAliveCounter
 PINGREQ retransmission counter. More...
MqttSnMessage message
 MQTT-SN message. More...
MqttSnMsgType msgType
 Message type. More...
uint16_t msgId
 Message identifier. More...
uint16_t topicId
 Topic identifier returned by the gateway (REGACK/SUBACK) More...
MqttSnReturnCode returnCode
 Status code returned by the gateway. More...
MqttSnClientTopicEntry topicTable [MQTT_SN_CLIENT_TOPIC_TABLE_SIZE]
MqttSnClientMsgIdEntry msgIdTable [MQTT_SN_CLIENT_MSG_ID_TABLE_SIZE]

Detailed Description

MQTT-SN client context.

Definition at line 238 of file mqtt_sn_client.h.

Field Documentation

◆ clientId

Client identifier.

Definition at line 246 of file mqtt_sn_client.h.

◆ dtlsContext

TlsContext* dtlsContext

DTLS context.

Definition at line 251 of file mqtt_sn_client.h.

◆ dtlsInitCallback

MqttSnClientDtlsInitCallback dtlsInitCallback

DTLS initialization callback.

Definition at line 253 of file mqtt_sn_client.h.

◆ dtlsSession

TlsSessionState dtlsSession

DTLS session state.

Definition at line 252 of file mqtt_sn_client.h.

◆ gwIpAddr

IpAddr gwIpAddr

Gateway IP address.

Definition at line 256 of file mqtt_sn_client.h.

◆ gwPort

uint16_t gwPort

Gateway port number.

Definition at line 257 of file mqtt_sn_client.h.

◆ interface

NetInterface* interface

Underlying network interface.

Definition at line 248 of file mqtt_sn_client.h.

◆ keepAlive

systime_t keepAlive

Keep-alive interval.

Definition at line 245 of file mqtt_sn_client.h.

◆ keepAliveCounter

uint_t keepAliveCounter

PINGREQ retransmission counter.

Definition at line 262 of file mqtt_sn_client.h.

◆ keepAliveTimestamp

systime_t keepAliveTimestamp

Timestamp used to manage keep-alive.

Definition at line 261 of file mqtt_sn_client.h.

◆ message

MqttSnMessage message

MQTT-SN message.

Definition at line 263 of file mqtt_sn_client.h.

◆ msgId

uint16_t msgId

Message identifier.

Definition at line 265 of file mqtt_sn_client.h.

◆ msgIdTable

◆ msgType

MqttSnMsgType msgType

Message type.

Definition at line 264 of file mqtt_sn_client.h.

◆ predefinedTopicTable

const MqttSnPredefinedTopic* predefinedTopicTable

List of predefined topics.

Definition at line 242 of file mqtt_sn_client.h.

◆ predefinedTopicTableSize

uint_t predefinedTopicTableSize

Number of predefined topics.

Definition at line 243 of file mqtt_sn_client.h.

◆ publishCallback

MqttSnClientPublishCallback publishCallback

PUBLISH message received callback.

Definition at line 255 of file mqtt_sn_client.h.

◆ retransmitStartTime

systime_t retransmitStartTime

Time at which the last message was sent.

Definition at line 259 of file mqtt_sn_client.h.

◆ retransmitTimeout

systime_t retransmitTimeout

Retransmission timeout.

Definition at line 260 of file mqtt_sn_client.h.

◆ returnCode

MqttSnReturnCode returnCode

Status code returned by the gateway.

Definition at line 267 of file mqtt_sn_client.h.

◆ socket

Socket* socket

Underlying TCP socket.

Definition at line 249 of file mqtt_sn_client.h.

◆ startTime

systime_t startTime

Start time.

Definition at line 258 of file mqtt_sn_client.h.

◆ state

MQTT-SN client state.

Definition at line 240 of file mqtt_sn_client.h.

◆ timeout

systime_t timeout

Timeout value.

Definition at line 244 of file mqtt_sn_client.h.

◆ topicId

uint16_t topicId

Topic identifier returned by the gateway (REGACK/SUBACK)

Definition at line 266 of file mqtt_sn_client.h.

◆ topicTable

◆ transportProtocol

MqttSnTransportProtocol transportProtocol

Transport protocol (UDP or DTLS)

Definition at line 241 of file mqtt_sn_client.h.

◆ willMessage

Will message.

Definition at line 247 of file mqtt_sn_client.h.

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