Definitions common to MQTT-SN client and gateway. More...

#include "core/net.h"

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
struct {
char_t type

uint32_t dataStart

uint32_t dataLength

uint8_t nameLength

char_t name []

uint8_t tokenLen: 4

uint8_t type: 2

uint8_t version: 2

uint8_t code

uint16_t mid

uint8_t token []

union {
uint8_t b [6]

uint16_t w [3]

}

uint16_t srcPort

uint16_t destPort

uint32_t seqNum

uint32_t ackNum

uint8_t reserved1: 4

uint8_t dataOffset: 4

uint8_t flags: 6

uint8_t reserved2: 2

uint16_t window

uint16_t checksum

uint16_t urgentPointer

uint8_t options []

uint16_t length

uint8_t data []

uint8_t op

uint8_t htype

uint8_t hlen

uint8_t hops

uint32_t xid

uint16_t secs

uint16_t flags

Ipv4Addr ciaddr

Ipv4Addr yiaddr

Ipv4Addr siaddr

Ipv4Addr giaddr

MacAddr chaddr

uint8_t unused [10]

uint8_t sname [64]

uint8_t file [128]

uint32_t magicCookie

uint16_t type

uint16_t hardwareType

uint32_t time

MacAddr linkLayerAddr

uint16_t id

uint8_t rd: 1

uint8_t tc: 1

uint8_t aa: 1

uint8_t opcode: 4

uint8_t qr: 1

uint8_t rcode: 4

uint8_t z: 3

uint8_t ra: 1

uint16_t qdcount

uint16_t ancount

uint16_t nscount

uint16_t arcount

uint8_t questions []

uint16_t controlWord

uint16_t byteCount

uint8_t bLength

uint8_t bDescriptorType

uint16_t bcdUsb

uint8_t bDeviceClass

uint8_t bDeviceSubClass

uint8_t bDeviceProtocol

uint8_t bMaxPacketSize0

uint16_t idVendor

uint16_t idProduct

uint16_t bcdDevice

uint8_t iManufacturer

uint8_t iProduct

uint8_t iSerialNumber

uint8_t bNumConfigurations

uint8_t maxRespTime

Ipv4Addr groupAddr

uint16_t hrd

uint16_t pro

uint8_t hln

uint8_t pln

uint16_t op

MacAddr sha

Ipv4Addr spa

MacAddr tha

Ipv4Addr tpa

uint8_t length

uint8_t value []

uint16_t first

uint16_t last

uint16_t next

union {
uint8_t b [16]

uint16_t w [8]

uint32_t dw [4]

}

uint16_t maxRespDelay

uint16_t reserved

Ipv6Addr multicastAddr

uint32_t reserved

uint16_t pvid

uint8_t autoNegSupportStatus

uint16_t pmdAutoNegAdvCap

uint16_t operationalMauType

uint16_t capabilities

uint8_t deviceType

uint8_t lengthH: 1

uint8_t lengthL

uint8_t t: 1

uint8_t c: 1

union {
int32_t integer

uint8_t octetString [1]

uint8_t oid [1]

uint8_t ipAddr [4]

uint32_t counter32

uint32_t gauge32

uint32_t unsigned32

uint32_t timeTicks

uint64_t counter64

}

uint16_t transactionId

uint16_t protocolId

uint8_t unitId

uint8_t pdu []

uint8_t retain: 1

uint8_t qos: 2

uint8_t dup: 1

union {
uint8_t all

struct {
uint8_t topicIdType: 2

uint8_t cleanSession: 1

uint8_t will: 1

uint8_t retain: 1

uint8_t qos: 2

uint8_t dup: 1

}

}

uint8_t b: 1

uint8_t identifier

uint8_t valueSize

Ipv4Addr srcIpAddr

Ipv4Addr destIpAddr

Eui64 interfaceId

uint16_t mru

uint8_t peerIdLength

uint8_t peerId []

uint32_t seconds

uint32_t fraction

uint16_t opcode

char_t filename []

uint8_t reserved: 3

uint8_t fin: 1

uint8_t payloadLen: 7

uint8_t mask: 1

uint8_t extPayloadLen []

uint32_t length

uint8_t payload []

uint8_t protocolVersionId

uint8_t bpduType

StpBridgeId rootId

uint32_t rootPathCost

StpBridgeId bridgeId

uint16_t portId

uint16_t messageAge

uint16_t maxAge

uint16_t helloTime

uint16_t forwardDelay

uint8_t version1Length

uint16_t priority

MacAddr addr

}	MqttSnFlags
	MQTT-SN flags. More...

struct {
char_t type

uint32_t dataStart

uint32_t dataLength

uint8_t nameLength

uint8_t length: 4

uint8_t delta: 4

union {
uint8_t b [8]

uint16_t w [4]

uint32_t dw [2]

}

uint8_t kind

uint8_t value []

uint8_t code

uint16_t type

uint32_t enterpriseNumber

uint8_t identifier []

uint16_t qtype

uint16_t qclass

uint16_t statusWord

uint16_t byteCount

uint8_t bLength

uint8_t bDescriptorType

uint16_t wTotalLength

uint8_t bNumInterfaces

uint8_t bConfigurationValue

uint8_t iConfiguration

uint8_t bmAttributes

uint8_t bMaxPower

uint8_t type

uint16_t checksum

uint8_t parameter

uint8_t unused [3]

uint8_t data []

uint32_t parameter

uint8_t nextHeader

uint8_t hdrExtLen

uint8_t options []

uint8_t curHopLimit

uint8_t reserved: 2

uint8_t p: 1

uint8_t prf: 2

uint8_t h: 1

uint8_t o: 1

uint8_t m: 1

uint16_t routerLifetime

uint32_t reachableTime

uint32_t retransTimer

uint8_t flags

uint16_t ppvid

uint8_t mdiPowerSupport

uint8_t psePowerPair

uint8_t powerClass

uint8_t appType

uint8_t vlanIdH: 5

uint8_t x: 1

uint8_t t: 1

uint8_t u: 1

uint8_t l2PriorityH: 1

uint8_t vlanIdL: 7

uint8_t dscpValue: 6

uint8_t l2PriorityL: 2

uint8_t chassisIdSubtype

uint8_t chassisId []

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfCoils

uint16_t length

uint8_t msgType

uint16_t flags

Ipv4Addr addr

uint8_t valueSize

uint16_t protocol

uint32_t accm

uint8_t msgLength

uint8_t message []

uint8_t mode: 3

uint8_t vn: 3

uint8_t li: 2

uint8_t stratum

uint8_t poll

int8_t precision

uint32_t rootDelay

uint32_t rootDispersion

uint32_t referenceId

NtpTimestamp referenceTimestamp

NtpTimestamp originateTimestamp

NtpTimestamp receiveTimestamp

NtpTimestamp transmitTimestamp

uint16_t opcode

char_t filename []

uint16_t value []

uint16_t group

uint8_t keyExchange []

uint32_t id

uint32_t dataLen

}	MqttSnHeader
	Message header. More...

struct {
uint32_t totalSize

ResRootEntry rootEntry

MacAddr destAddr

MacAddr srcAddr

uint16_t type

uint8_t data []

uint16_t hardwareType

MacAddr linkLayerAddr

uint16_t rtype

uint16_t rclass

uint32_t ttl

uint16_t rdlength

uint8_t rdata []

uint8_t bLength

uint8_t bDescriptorType

uint8_t bInterfaceNumber

uint8_t bAlternateSetting

uint8_t bNumEndpoints

uint8_t bInterfaceClass

uint8_t bInterfaceSubClass

uint8_t bInterfaceProtocol

uint8_t iInterface

uint8_t type

uint8_t code

uint16_t checksum

uint32_t unused

uint8_t nextHeader

uint8_t hdrExtLen

uint8_t options []

uint32_t reserved

Ipv6Addr targetAddr

uint16_t vlanId

uint8_t vlanNameLen

char_t vlanName []

uint8_t aggregationStatus

uint32_t aggregatedPortId

uint8_t locationDataFormat

uint8_t locationId []

uint8_t portIdSubtype

uint8_t portId []

uint8_t functionCode

uint8_t byteCount

uint8_t coilStatus []

uint8_t prefix

uint16_t length

uint8_t msgType

uint8_t identifier

uint8_t message []

uint8_t length

Ipv4Addr ipAddr

uint16_t protocol

uint8_t msgLength

uint8_t rejectedPacket []

uint32_t keyId

uint8_t messageDigest [16]

uint16_t opcode

uint16_t block

uint16_t value []

uint8_t value []

}	MqttSnExtHeader
	Extended message header. More...

struct {
uint8_t dsap

uint8_t ssap

uint8_t control

uint8_t msgType

uint8_t transactionId [3]

uint8_t options []

uint16_t rtype

uint16_t rclass

uint32_t ttl

uint16_t rdlength

uint8_t rdata [4]

uint8_t bLength

uint8_t bDescriptorType

uint8_t bEndpointAddress

uint8_t bmAttributes

uint16_t wMaxPacketSize

uint8_t bInterval

uint8_t type

uint8_t code

uint16_t checksum

uint32_t unused

uint8_t data []

uint32_t mtu

uint8_t nextHeader

uint8_t hdrExtLen

uint8_t routingType

uint8_t segmentsLeft

uint32_t reserved

Ipv6Addr address []

uint8_t reserved1: 5

uint8_t o: 1

uint8_t s: 1

uint8_t r: 1

uint8_t reserved2 [3]

Ipv6Addr targetAddr

uint8_t protocolIdLen

uint8_t protocolId []

uint16_t maxFrameSize

uint8_t powerPriority: 4

uint8_t powerSource: 2

uint8_t powerType: 2

uint16_t powerValue

uint16_t ttl

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfInputs

uint8_t gwId

uint16_t duration

uint8_t identifier

uint16_t length

uint8_t message []

uint8_t length

Ipv4Addr ipAddr

uint16_t protocol

uint16_t rejectedProtocol

uint8_t rejectedInfo []

uint16_t opcode

uint16_t block

uint16_t version

uint16_t epoch

DtlsSequenceNumber seqNum

uint8_t hash

uint8_t signature

uint8_t value []

}	MqttSnAdvertise
	ADVERTISE message. More...

struct {
uint16_t tci

uint16_t type

uint8_t msgType

uint8_t hopCount

Ipv6Addr linkAddress

Ipv6Addr peerAddress

uint8_t options []

uint16_t rtype

uint16_t rclass

uint32_t ttl

uint16_t rdlength

uint8_t rdata [16]

uint8_t bLength

uint8_t bDescriptorType

uint16_t bString []

uint8_t type

uint8_t code

uint16_t checksum

uint8_t pointer

uint8_t unused [3]

uint8_t data []

uint32_t unused

uint8_t nextHeader

uint8_t payloadLen

uint16_t reserved

uint32_t securityParamIndex

uint32_t sequenceNumber

uint8_t authData []

uint32_t reserved

Ipv6Addr targetAddr

Ipv6Addr destAddr

uint8_t measurements [20]

uint16_t psePowerPriceIndex

uint16_t supportedCap

uint16_t enabledCap

uint8_t functionCode

uint8_t byteCount

uint8_t inputStatus []

uint8_t radius

uint8_t length

Ipv4Addr ipAddr

uint32_t magicNumber

uint8_t identifier

uint16_t length

uint16_t opcode

uint16_t errorCode

char_t errorMsg []

uint16_t msgSeq

uint8_t fragOffset [3]

uint8_t fragLength [3]

TlsSignHashAlgo value []

uint8_t value []

}	MqttSnSearchGw
	SEARCHGW message. More...

struct {
uint16_t code

uint16_t length

uint8_t value []

uint16_t rtype

uint16_t rclass

uint32_t ttl

uint16_t rdlength

uint16_t priority

uint16_t weight

uint16_t port

uint8_t target []

uint8_t bFunctionLength

uint8_t bDescriptorType

uint8_t bDescriptorSubtype

uint16_t bcdCdc

uint8_t type

uint8_t code

uint16_t checksum

uint16_t identifier

uint16_t sequenceNumber

uint8_t data []

uint32_t pointer

uint32_t securityParamIndex

uint32_t sequenceNumber

uint8_t payloadData []

uint8_t length

uint8_t powerPriority: 2

uint8_t pd4pid: 1

uint8_t reserved: 1

uint8_t powerSource: 2

uint8_t powerType: 2

uint16_t pdRequestedPower

uint16_t pseAllocatedPower

uint8_t mgmtAddrLen

uint8_t mgmtAddrSubtype

uint8_t mgmtAddr []

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfRegs

uint8_t gwId

uint8_t gwAdd []

Ipv4Addr ipAddr

uint8_t identifier

uint32_t magicNumber

uint16_t serverVersion

uint8_t cookieLength

uint8_t cookie []

}	MqttSnGwInfo
	GWINFO message. More...

struct {
uint32_t iaId

uint32_t t1

uint32_t t2

uint8_t options []

uint8_t bFunctionLength

uint8_t bDescriptorType

uint8_t bDescriptorSubtype

uint8_t bmCapabilities

uint8_t bDataInterface

uint8_t type

uint8_t code

uint16_t checksum

uint16_t identifier

uint16_t sequenceNumber

uint8_t data []

uint8_t length

MacAddr linkLayerAddr

uint16_t pdRequestedPowerA

uint16_t pdRequestedPowerB

uint16_t pseAllocatedPowerA

uint16_t pseAllocatedPowerB

uint16_t powerStatus

uint8_t systemSetup

uint16_t pseMaxAvailablePower

uint8_t autoclass

uint8_t powerDown [3]

uint8_t ifNumSubtype

uint32_t ifNum

uint8_t oidLen

uint8_t oid []

uint8_t functionCode

uint8_t byteCount

uint16_t regValue []

MqttSnFlags flags

uint8_t protocolId

uint16_t duration

char_t clientId []

Ipv4Addr ipAddr

uint16_t length

uint8_t value []

}	MqttSnConnect
	CONNECT message. More...

struct {
uint32_t iaId

uint8_t options []

uint8_t bFunctionLength

uint8_t bDescriptorType

uint8_t bDescriptorSubtype

uint8_t bmCapabilities

uint8_t type

uint8_t length

uint8_t prefixLength

uint8_t reserved1: 5

uint8_t r: 1

uint8_t a: 1

uint8_t l: 1

uint32_t validLifetime

uint32_t preferredLifetime

uint32_t reserved2

Ipv6Addr prefix

uint8_t oui [LLDP_OUI_SIZE]

uint8_t subtype

uint8_t value []

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfRegs

uint8_t returnCode

uint16_t type

uint16_t length

}	MqttSnConnAck
	CONNACK message. More...

typedef void	MqttSnWillTopicReq
	WILLTOPICREQ message. More...

struct {
Ipv6Addr address

uint32_t preferredLifetime

uint32_t validLifetime

uint8_t options []

uint8_t bFunctionLength

uint8_t bDescriptorType

uint8_t bDescriptorSubtype

uint8_t bMasterInterface

uint8_t bSlaveInterface0

uint8_t type

uint8_t length

uint16_t reserved1

uint32_t reserved2

uint8_t ipPacket []

uint8_t functionCode

uint8_t byteCount

uint16_t regValue []

MqttSnFlags flags

char_t willTopic []

uint16_t length

uint8_t value []

}	MqttSnWillTopic
	WILLTOPIC message. More...

typedef void	MqttSnWillMsgReq
	WILLMSGREQ message. More...

typedef void	MqttSnWillMsg
	WILLMSG message. More...

struct {
uint16_t requestedOption [1]

UsbConfigDescriptor configDescriptor

UsbInterfaceDescriptor communicationInterfaceDescriptor

CdcHeaderDescriptor cdcHeaderDescriptor

CdcCallManagementDescriptor cdcCallManagementDescriptor

CdcAcmDescriptor cdcAcmDescriptor

CdcUnionDescriptor cdcUnionDescriptor

UsbEndpointDescriptor notificationEndpointDescriptor

UsbInterfaceDescriptor dataInterfaceDescriptor

UsbEndpointDescriptor dataOutEndpointDescriptor

UsbEndpointDescriptor dataInEndpointDescriptor

uint8_t type

uint8_t length

uint16_t reserved

uint32_t mtu

uint8_t functionCode

uint16_t outputAddr

uint16_t outputValue

uint16_t topicId

uint16_t msgId

char_t topicName []

uint16_t value []

uint16_t algorithm

uint16_t length

uint8_t value []

}	MqttSnRegister
	REGISTER message. More...

struct {
uint8_t value

uint8_t type

uint8_t length

uint8_t prefixLength

uint8_t reserved2: 3

uint8_t prf: 2

uint8_t reserved1: 3

uint32_t routeLifetime

Ipv6Addr prefix

uint8_t functionCode

uint16_t outputAddr

uint16_t outputValue

uint16_t topicId

uint16_t msgId

uint8_t returnCode

uint16_t length

char_t hostname []

uint16_t serverVersion

uint8_t random [32]

uint8_t sessionIdLen

uint8_t sessionId []

}	MqttSnRegAck
	REGACK message. More...

struct {
uint16_t value

uint8_t type

uint8_t length

uint16_t reserved

uint32_t lifetime

Ipv6Addr address []

uint8_t functionCode

uint16_t regAddr

uint16_t regValue

MqttSnFlags flags

uint16_t topicId

uint16_t msgId

uint8_t data []

uint16_t length

uint8_t value []

uint16_t extensionsLen

uint8_t extensions []

}	MqttSnPublish
	PUBLISH message. More...

struct {
uint8_t protocol

uint8_t algorithm

uint8_t rdm

uint8_t replayDetection [8]

uint8_t authInfo []

uint8_t type

uint8_t length

uint16_t reserved

uint32_t lifetime

uint8_t domainNames []

uint8_t functionCode

uint16_t regAddr

uint16_t regValue

uint16_t topicId

uint16_t msgId

uint8_t returnCode

char_t value []

uint32_t ticketLifetime

uint32_t ticketAgeAdd

uint8_t ticketNonceLen

uint8_t ticketNonce []

}	MqttSnPubAck
	PUBACK message. More...

struct {
Ipv6Addr serverAddr

uint8_t type

uint8_t length

uint8_t contextLength

uint8_t cid: 4

uint8_t c: 1

uint8_t reserved1: 3

uint16_t reserved2

uint16_t validLifetime

Ipv6Addr contextPrefix

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfOutputs

uint8_t byteCount

uint8_t outputValue []

uint16_t msgId

uint16_t length

uint8_t value []

uint8_t requestUpdate

}	MqttSnPubRec
	PUBREC message. More...

struct {
uint16_t statusCode

char_t statusMessage []

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfOutputs

uint16_t msgId

uint16_t length

uint16_t value []

uint8_t data []

}	MqttSnPubRel
	PUBREL message. More...

struct {
uint8_t msgType

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfRegs

uint8_t byteCount

uint16_t regValue []

uint16_t msgId

uint8_t length

uint8_t value []

uint16_t version
	Protocol version. More...

uint16_t cipherSuite
	Cipher suite identifier. More...

systime_t ticketTimestamp
	Timestamp to manage ticket lifetime. More...

uint32_t ticketLifetime
	Lifetime of the ticket. More...

uint32_t ticketAgeAdd
	Random value used to obscure the age of the ticket. More...

uint8_t ticketNonce [4]
	A per-ticket value that is unique across all tickets issued. More...

size_t ticketPskLen
	Length of the PSK associated with the ticket. More...

uint8_t ticketPsk [TLS13_MAX_HKDF_DIGEST_SIZE]
	PSK associated with the ticket. More...

}	MqttSnPubComp
	PUBCOMP message. More...

struct {
Ipv6Addr address [1]

uint8_t functionCode

uint16_t startingAddr

uint16_t quantityOfRegs

MqttSnFlags flags

uint16_t msgId

char_t topicName []

uint8_t length

uint8_t value []

}	MqttSnSubscribe
	SUBSCRIBE message. More...

struct {
uint8_t searchList [1]

uint8_t functionCode

uint16_t referenceAddr

uint16_t andMask

uint16_t orMask

MqttSnFlags flags

uint16_t topicId

uint16_t msgId

uint8_t returnCode

uint8_t length

uint8_t value []

}	MqttSnSubAck
	SUBACK message. More...

struct {
uint32_t iaId

uint32_t t1

uint32_t t2

uint8_t options []

uint8_t functionCode

uint16_t referenceAddr

uint16_t andMask

uint16_t orMask

MqttSnFlags flags

uint16_t msgId

char_t topicName []

uint16_t length

uint8_t value []

}	MqttSnUnsubscribe
	UNSUBSCRIBE message. More...

struct {
uint32_t preferredLifetime

uint32_t validLifetime

uint8_t prefixLen

Ipv6Addr prefix

uint8_t options []

uint8_t functionCode

uint16_t readStartingAddr

uint16_t quantityToRead

uint16_t writeStartingAddr

uint16_t quantityToWrite

uint8_t writeByteCount

uint16_t writeRegValue []

uint16_t msgId

uint16_t length

uint8_t value []

}	MqttSnUnsubAck
	UNSUBACK message. More...

typedef void	MqttSnPingReq
	PINGREQ message. More...

typedef void	MqttSnPingResp
	PINGRESP message. More...

struct {
uint8_t s: 1

uint8_t o: 1

uint8_t n: 1

uint8_t mbz: 5

uint8_t domainName []

uint8_t functionCode

uint8_t readByteCount

uint16_t readRegValue []

uint16_t duration

uint16_t length

uint8_t value []

}	MqttSnDisconnect
	DISCONNECT message. More...

struct {
uint8_t functionCode

uint8_t exceptionCode

MqttSnFlags flags

char_t willTopic []

TlsSignHashAlgo algorithm

uint16_t length

uint8_t value []

}	MqttSnWillTopicUpd
	WILLTOPICUPD message. More...

struct {
uint8_t returnCode

uint8_t type

uint16_t version

uint16_t length

uint8_t data []

}	MqttSnWillTopicResp
	WILLTOPICRESP message. More...

typedef void	MqttSnWillMsgUpd
	WILLMSGUPD message. More...

struct {
uint8_t returnCode

uint8_t msgType

uint8_t length [3]

uint8_t data []

}	MqttSnWillMsgResp
	WILLMSGRESP message. More...

Enumerations
enum	MqttSnTransportProtocol { MQTT_SN_TRANSPORT_PROTOCOL_UDP = 1, MQTT_SN_TRANSPORT_PROTOCOL_DTLS = 2 }
	MQTT-SN transport protocols. More...

enum	MqttSnQosLevel { MQTT_SN_QOS_LEVEL_0 = 0, MQTT_SN_QOS_LEVEL_1 = 1, MQTT_SN_QOS_LEVEL_2 = 2, MQTT_SN_QOS_LEVEL_MINUS_1 = 3 }
	Quality of service level. More...

enum	MqttSnTopicIdType { MQTT_SN_NORMAL_TOPIC_ID = 0, MQTT_SN_PREDEFINED_TOPIC_ID = 1, MQTT_SN_NORMAL_TOPIC_NAME = 0, MQTT_SN_SHORT_TOPIC_NAME = 2 }
	Topic ID types. More...

enum	MqttSnMsgType { MQTT_SN_MSG_TYPE_ADVERTISE = 0x00, MQTT_SN_MSG_TYPE_SEARCHGW = 0x01, MQTT_SN_MSG_TYPE_GWINFO = 0x02, MQTT_SN_MSG_TYPE_CONNECT = 0x04, MQTT_SN_MSG_TYPE_CONNACK = 0x05, MQTT_SN_MSG_TYPE_WILLTOPICREQ = 0x06, MQTT_SN_MSG_TYPE_WILLTOPIC = 0x07, MQTT_SN_MSG_TYPE_WILLMSGREQ = 0x08, MQTT_SN_MSG_TYPE_WILLMSG = 0x09, MQTT_SN_MSG_TYPE_REGISTER = 0x0A, MQTT_SN_MSG_TYPE_REGACK = 0x0B, MQTT_SN_MSG_TYPE_PUBLISH = 0x0C, MQTT_SN_MSG_TYPE_PUBACK = 0x0D, MQTT_SN_MSG_TYPE_PUBCOMP = 0x0E, MQTT_SN_MSG_TYPE_PUBREC = 0x0F, MQTT_SN_MSG_TYPE_PUBREL = 0x10, MQTT_SN_MSG_TYPE_SUBSCRIBE = 0x12, MQTT_SN_MSG_TYPE_SUBACK = 0x13, MQTT_SN_MSG_TYPE_UNSUBSCRIBE = 0x14, MQTT_SN_MSG_TYPE_UNSUBACK = 0x15, MQTT_SN_MSG_TYPE_PINGREQ = 0x16, MQTT_SN_MSG_TYPE_PINGRESP = 0x17, MQTT_SN_MSG_TYPE_DISCONNECT = 0x18, MQTT_SN_MSG_TYPE_WILLTOPICUPD = 0x1A, MQTT_SN_MSG_TYPE_WILLTOPICRESP = 0x1B, MQTT_SN_MSG_TYPE_WILLMSGUPD = 0x1C, MQTT_SN_MSG_TYPE_WILLMSGRESP = 0x1D, MQTT_SN_MSG_TYPE_ENCAPSULATED = 0xFE }
	MQTT-SN message types. More...

enum	MqttSnReturnCode { MQTT_SN_RETURN_CODE_ACCEPTED = 0, MQTT_SN_RETURN_CODE_REJECTED_CONGESTION = 1, MQTT_SN_RETURN_CODE_REJECTED_INVALID_TOPIC_ID = 2, MQTT_SN_RETURN_CODE_REJECTED_NOT_SUPPORTED = 3 }
	MQTT-SN return codes. More...

Detailed Description

Definitions common to MQTT-SN client and gateway.

License

SPDX-License-Identifier: GPL-2.0-or-later

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.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.2.4

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

◆ MqttSnAdvertise

typedef { ... } MqttSnAdvertise

ADVERTISE message.

◆ MqttSnConnAck

typedef { ... } MqttSnConnAck

CONNACK message.

◆ MqttSnConnect

typedef { ... } MqttSnConnect

CONNECT message.

◆ MqttSnDisconnect

typedef { ... } MqttSnDisconnect

DISCONNECT message.

◆ MqttSnExtHeader

typedef { ... } MqttSnExtHeader

Extended message header.

◆ MqttSnFlags

typedef { ... } MqttSnFlags

MQTT-SN flags.

◆ MqttSnGwInfo

typedef { ... } MqttSnGwInfo

GWINFO message.

◆ MqttSnHeader

typedef { ... } MqttSnHeader

Message header.

◆ 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.

◆ MqttSnPubAck

typedef { ... } MqttSnPubAck

PUBACK message.

◆ MqttSnPubComp

typedef { ... } MqttSnPubComp

PUBCOMP message.

◆ MqttSnPublish

typedef { ... } MqttSnPublish

PUBLISH message.

◆ MqttSnPubRec

typedef { ... } MqttSnPubRec

PUBREC message.

◆ MqttSnPubRel

typedef { ... } MqttSnPubRel

PUBREL message.

◆ MqttSnRegAck

typedef { ... } MqttSnRegAck

REGACK message.

◆ MqttSnRegister

typedef { ... } MqttSnRegister

REGISTER message.

◆ MqttSnSearchGw

typedef { ... } MqttSnSearchGw

SEARCHGW message.

◆ MqttSnSubAck

typedef { ... } MqttSnSubAck

SUBACK message.

◆ MqttSnSubscribe

typedef { ... } MqttSnSubscribe

SUBSCRIBE message.

◆ MqttSnUnsubAck

typedef { ... } MqttSnUnsubAck

UNSUBACK message.

◆ MqttSnUnsubscribe

typedef { ... } MqttSnUnsubscribe

UNSUBSCRIBE message.

◆ 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.

◆ MqttSnWillMsgResp

typedef { ... } MqttSnWillMsgResp

WILLMSGRESP message.

◆ MqttSnWillMsgUpd

typedef void MqttSnWillMsgUpd

WILLMSGUPD message.

Definition at line 461 of file mqtt_sn_common.h.

◆ MqttSnWillTopic

typedef { ... } MqttSnWillTopic

WILLTOPIC message.

◆ MqttSnWillTopicReq

typedef void MqttSnWillTopicReq

WILLTOPICREQ message.

Definition at line 258 of file mqtt_sn_common.h.

◆ MqttSnWillTopicResp

typedef { ... } MqttSnWillTopicResp

WILLTOPICRESP message.

◆ MqttSnWillTopicUpd

typedef { ... } MqttSnWillTopicUpd

WILLTOPICUPD message.

Enumeration Type Documentation

◆ MqttSnMsgType

enum MqttSnMsgType

MQTT-SN message types.

Enumerator
MQTT_SN_MSG_TYPE_ADVERTISE
MQTT_SN_MSG_TYPE_SEARCHGW
MQTT_SN_MSG_TYPE_GWINFO
MQTT_SN_MSG_TYPE_CONNECT
MQTT_SN_MSG_TYPE_CONNACK
MQTT_SN_MSG_TYPE_WILLTOPICREQ
MQTT_SN_MSG_TYPE_WILLTOPIC
MQTT_SN_MSG_TYPE_WILLMSGREQ
MQTT_SN_MSG_TYPE_WILLMSG
MQTT_SN_MSG_TYPE_REGISTER
MQTT_SN_MSG_TYPE_REGACK
MQTT_SN_MSG_TYPE_PUBLISH
MQTT_SN_MSG_TYPE_PUBACK
MQTT_SN_MSG_TYPE_PUBCOMP
MQTT_SN_MSG_TYPE_PUBREC
MQTT_SN_MSG_TYPE_PUBREL
MQTT_SN_MSG_TYPE_SUBSCRIBE
MQTT_SN_MSG_TYPE_SUBACK
MQTT_SN_MSG_TYPE_UNSUBSCRIBE
MQTT_SN_MSG_TYPE_UNSUBACK
MQTT_SN_MSG_TYPE_PINGREQ
MQTT_SN_MSG_TYPE_PINGRESP
MQTT_SN_MSG_TYPE_DISCONNECT
MQTT_SN_MSG_TYPE_WILLTOPICUPD
MQTT_SN_MSG_TYPE_WILLTOPICRESP
MQTT_SN_MSG_TYPE_WILLMSGUPD
MQTT_SN_MSG_TYPE_WILLMSGRESP
MQTT_SN_MSG_TYPE_ENCAPSULATED

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

enum 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

◆ all

uint8_t all

Definition at line 151 of file mqtt_sn_common.h.

◆ cleanSession

uint8_t cleanSession

Definition at line 163 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.

◆ dup

uint8_t dup

Definition at line 167 of file mqtt_sn_common.h.

◆ duration

uint16_t duration

Definition at line 206 of file mqtt_sn_common.h.

◆ flags

MqttSnFlags flags

Definition at line 237 of file mqtt_sn_common.h.

◆ gwAdd

uint8_t gwAdd[]

Definition at line 227 of file mqtt_sn_common.h.

◆ gwId

uint8_t gwId

Definition at line 205 of file mqtt_sn_common.h.

◆ length

uint16_t length

Definition at line 180 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.

◆ prefix

uint8_t prefix

Definition at line 192 of file mqtt_sn_common.h.

◆ protocolId

uint8_t protocolId

Definition at line 238 of file mqtt_sn_common.h.

◆ qos

uint8_t qos

Definition at line 166 of file mqtt_sn_common.h.

◆ radius

uint8_t radius

Definition at line 216 of file mqtt_sn_common.h.

◆ retain

uint8_t retain

Definition at line 165 of file mqtt_sn_common.h.

◆ returnCode

uint8_t returnCode

Definition at line 250 of file mqtt_sn_common.h.

◆ topicId

uint16_t topicId

Definition at line 292 of file mqtt_sn_common.h.

◆ topicIdType

uint8_t topicIdType

Definition at line 162 of file mqtt_sn_common.h.

◆ topicName

char_t topicName[]

Definition at line 294 of file mqtt_sn_common.h.

◆ will

uint8_t will

Definition at line 164 of file mqtt_sn_common.h.

◆ willTopic

char_t willTopic[]

Definition at line 268 of file mqtt_sn_common.h.

Data Structures

Macros

Typedefs

Enumerations