Definitions common to MQTT-SN client and gateway. More...
#include "core/net.h"
Go to the source code of this file.
Data Structures | |
struct | MqttSnPredefinedTopic |
Predefined topic. More... | |
Macros | |
#define | MQTT_SN_PORT 1883 |
#define | MQTT_SN_PROTOCOL_ID 0x01 |
#define | MQTT_SN_INVALID_TOPIC_ID 0x0000 |
Typedefs | |
typedef void | MqttSnWillTopicReq |
WILLTOPICREQ message. More... | |
typedef void | MqttSnWillMsgReq |
WILLMSGREQ message. More... | |
typedef void | MqttSnWillMsg |
WILLMSG message. More... | |
typedef void | MqttSnPingReq |
PINGREQ message. More... | |
typedef void | MqttSnPingResp |
PINGRESP message. More... | |
typedef void | MqttSnWillMsgUpd |
WILLMSGUPD message. More... | |
Variables | |
typedef | __packed_struct |
MQTT-SN flags. More... | |
MqttSnFlags | |
uint8_t | msgType |
uint8_t | data [] |
MqttSnHeader | |
uint16_t | length |
MqttSnExtHeader | |
uint16_t | duration |
MqttSnAdvertise | |
MqttSnSearchGw | |
uint8_t | gwAdd [] |
MqttSnGwInfo | |
uint8_t | protocolId |
char_t | clientId [] |
MqttSnConnect | |
MqttSnConnAck | |
char_t | willTopic [] |
MqttSnWillTopic | |
uint16_t | msgId |
char_t | topicName [] |
MqttSnRegister | |
uint8_t | returnCode |
MqttSnRegAck | |
uint16_t | topicId |
MqttSnPublish | |
MqttSnPubAck | |
MqttSnPubRec | |
MqttSnPubRel | |
MqttSnPubComp | |
MqttSnSubscribe | |
MqttSnSubAck | |
MqttSnUnsubscribe | |
MqttSnUnsubAck | |
MqttSnDisconnect | |
MqttSnWillTopicUpd | |
MqttSnWillTopicResp | |
MqttSnWillMsgResp | |
Detailed Description
Definitions common to MQTT-SN client and gateway.
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2023 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version
- 2.3.0
Definition in file mqtt_sn_common.h.
Macro Definition Documentation
◆ MQTT_SN_INVALID_TOPIC_ID
#define MQTT_SN_INVALID_TOPIC_ID 0x0000 |
Definition at line 48 of file mqtt_sn_common.h.
◆ MQTT_SN_PORT
#define MQTT_SN_PORT 1883 |
Definition at line 38 of file mqtt_sn_common.h.
◆ MQTT_SN_PROTOCOL_ID
#define MQTT_SN_PROTOCOL_ID 0x01 |
Definition at line 46 of file mqtt_sn_common.h.
Typedef Documentation
◆ MqttSnPingReq
typedef void MqttSnPingReq |
PINGREQ message.
Definition at line 416 of file mqtt_sn_common.h.
◆ MqttSnPingResp
typedef void MqttSnPingResp |
PINGRESP message.
Definition at line 423 of file mqtt_sn_common.h.
◆ MqttSnWillMsg
typedef void MqttSnWillMsg |
WILLMSG message.
Definition at line 283 of file mqtt_sn_common.h.
◆ MqttSnWillMsgReq
typedef void MqttSnWillMsgReq |
WILLMSGREQ message.
Definition at line 276 of file mqtt_sn_common.h.
◆ MqttSnWillMsgUpd
typedef void MqttSnWillMsgUpd |
WILLMSGUPD message.
Definition at line 461 of file mqtt_sn_common.h.
◆ MqttSnWillTopicReq
typedef void MqttSnWillTopicReq |
WILLTOPICREQ message.
Definition at line 258 of file mqtt_sn_common.h.
Enumeration Type Documentation
◆ MqttSnMsgType
enum MqttSnMsgType |
MQTT-SN message types.
Definition at line 91 of file mqtt_sn_common.h.
◆ MqttSnQosLevel
enum MqttSnQosLevel |
Quality of service level.
Enumerator | |
---|---|
MQTT_SN_QOS_LEVEL_0 | At most once delivery. |
MQTT_SN_QOS_LEVEL_1 | At least once delivery. |
MQTT_SN_QOS_LEVEL_2 | Exactly once delivery. |
MQTT_SN_QOS_LEVEL_MINUS_1 | No connection setup. |
Definition at line 65 of file mqtt_sn_common.h.
◆ MqttSnReturnCode
enum MqttSnReturnCode |
MQTT-SN return codes.
Enumerator | |
---|---|
MQTT_SN_RETURN_CODE_ACCEPTED | |
MQTT_SN_RETURN_CODE_REJECTED_CONGESTION | |
MQTT_SN_RETURN_CODE_REJECTED_INVALID_TOPIC_ID | |
MQTT_SN_RETURN_CODE_REJECTED_NOT_SUPPORTED |
Definition at line 128 of file mqtt_sn_common.h.
◆ MqttSnTopicIdType
enum MqttSnTopicIdType |
Topic ID types.
Enumerator | |
---|---|
MQTT_SN_NORMAL_TOPIC_ID | Normal topic ID. |
MQTT_SN_PREDEFINED_TOPIC_ID | Predefined topic ID. |
MQTT_SN_NORMAL_TOPIC_NAME | Normal topic name. |
MQTT_SN_SHORT_TOPIC_NAME | Short topic name. |
Definition at line 78 of file mqtt_sn_common.h.
◆ MqttSnTransportProtocol
MQTT-SN transport protocols.
Enumerator | |
---|---|
MQTT_SN_TRANSPORT_PROTOCOL_UDP | UDP protocol. |
MQTT_SN_TRANSPORT_PROTOCOL_DTLS | DTLS protocol. |
Definition at line 55 of file mqtt_sn_common.h.
Variable Documentation
◆ __packed_struct
typedef __packed_struct |
MQTT-SN flags.
WILLMSGRESP message.
WILLTOPICRESP message.
WILLTOPICUPD message.
DISCONNECT message.
UNSUBACK message.
UNSUBSCRIBE message.
SUBACK message.
SUBSCRIBE message.
PUBCOMP message.
PUBREL message.
PUBREC message.
PUBACK message.
PUBLISH message.
REGACK message.
REGISTER message.
WILLTOPIC message.
CONNACK message.
CONNECT message.
GWINFO message.
SEARCHGW message.
ADVERTISE message.
Extended message header.
Message header.
Definition at line 147 of file mqtt_sn_common.h.
◆ clientId
char_t clientId[] |
Definition at line 240 of file mqtt_sn_common.h.
◆ data
uint8_t data[] |
Definition at line 182 of file mqtt_sn_common.h.
◆ duration
uint16_t duration |
Definition at line 206 of file mqtt_sn_common.h.
◆ gwAdd
uint8_t gwAdd[] |
Definition at line 227 of file mqtt_sn_common.h.
◆ length
uint16_t length |
Definition at line 193 of file mqtt_sn_common.h.
◆ MqttSnAdvertise
MqttSnAdvertise |
Definition at line 207 of file mqtt_sn_common.h.
◆ MqttSnConnAck
MqttSnConnAck |
Definition at line 251 of file mqtt_sn_common.h.
◆ MqttSnConnect
MqttSnConnect |
Definition at line 241 of file mqtt_sn_common.h.
◆ MqttSnDisconnect
MqttSnDisconnect |
Definition at line 433 of file mqtt_sn_common.h.
◆ MqttSnExtHeader
MqttSnExtHeader |
Definition at line 196 of file mqtt_sn_common.h.
◆ MqttSnFlags
MqttSnFlags |
Definition at line 171 of file mqtt_sn_common.h.
◆ MqttSnGwInfo
MqttSnGwInfo |
Definition at line 228 of file mqtt_sn_common.h.
◆ MqttSnHeader
MqttSnHeader |
Definition at line 183 of file mqtt_sn_common.h.
◆ MqttSnPubAck
MqttSnPubAck |
Definition at line 332 of file mqtt_sn_common.h.
◆ MqttSnPubComp
MqttSnPubComp |
Definition at line 362 of file mqtt_sn_common.h.
◆ MqttSnPublish
MqttSnPublish |
Definition at line 320 of file mqtt_sn_common.h.
◆ MqttSnPubRec
MqttSnPubRec |
Definition at line 342 of file mqtt_sn_common.h.
◆ MqttSnPubRel
MqttSnPubRel |
Definition at line 352 of file mqtt_sn_common.h.
◆ MqttSnRegAck
MqttSnRegAck |
Definition at line 307 of file mqtt_sn_common.h.
◆ MqttSnRegister
MqttSnRegister |
Definition at line 295 of file mqtt_sn_common.h.
◆ MqttSnSearchGw
MqttSnSearchGw |
Definition at line 217 of file mqtt_sn_common.h.
◆ MqttSnSubAck
MqttSnSubAck |
Definition at line 387 of file mqtt_sn_common.h.
◆ MqttSnSubscribe
MqttSnSubscribe |
Definition at line 374 of file mqtt_sn_common.h.
◆ MqttSnUnsubAck
MqttSnUnsubAck |
Definition at line 409 of file mqtt_sn_common.h.
◆ MqttSnUnsubscribe
MqttSnUnsubscribe |
Definition at line 399 of file mqtt_sn_common.h.
◆ MqttSnWillMsgResp
MqttSnWillMsgResp |
Definition at line 471 of file mqtt_sn_common.h.
◆ MqttSnWillTopic
MqttSnWillTopic |
Definition at line 269 of file mqtt_sn_common.h.
◆ MqttSnWillTopicResp
MqttSnWillTopicResp |
Definition at line 454 of file mqtt_sn_common.h.
◆ MqttSnWillTopicUpd
MqttSnWillTopicUpd |
Definition at line 444 of file mqtt_sn_common.h.
◆ msgId
uint16_t msgId |
Definition at line 293 of file mqtt_sn_common.h.
◆ msgType
uint8_t msgType |
Definition at line 181 of file mqtt_sn_common.h.
◆ protocolId
uint8_t protocolId |
Definition at line 238 of file mqtt_sn_common.h.
◆ returnCode
uint8_t returnCode |
Definition at line 306 of file mqtt_sn_common.h.
◆ topicId
uint16_t topicId |
Definition at line 317 of file mqtt_sn_common.h.
◆ topicName
char_t topicName |
Definition at line 294 of file mqtt_sn_common.h.
◆ willTopic
char_t willTopic |
Definition at line 268 of file mqtt_sn_common.h.