mqtt_common.h File Reference

Definitions common to MQTT client and server. More...

#include "core/net.h"

Go to the source code of this file.

Macros

#define MQTT_PORT   1883
 
#define MQTT_TLS_PORT   8883
 
#define MQTT_PROTOCOL_NAME_3_1   "MQIsdp"
 
#define MQTT_PROTOCOL_NAME_3_1_1   "MQTT"
 
#define MQTT_MIN_HEADER_SIZE   2
 
#define MQTT_MAX_HEADER_SIZE   5
 

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
 
MqttPacketHeader
 Fixed header. 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
 
MqttString
 UTF-8 encoded string. More...
 

Enumerations

enum  MqttVersion { MQTT_VERSION_3_1 = 3, MQTT_VERSION_3_1_1 = 4 }
 MQTT protocol level. More...
 
enum  MqttTransportProtocol { MQTT_TRANSPORT_PROTOCOL_TCP = 1, MQTT_TRANSPORT_PROTOCOL_TLS = 2, MQTT_TRANSPORT_PROTOCOL_WS = 3, MQTT_TRANSPORT_PROTOCOL_WSS = 4 }
 Transport protocol. More...
 
enum  MqttQosLevel { MQTT_QOS_LEVEL_0 = 0, MQTT_QOS_LEVEL_1 = 1, MQTT_QOS_LEVEL_2 = 2 }
 Quality of service level. More...
 
enum  MqttPacketType {
  MQTT_PACKET_TYPE_INVALID = 0, MQTT_PACKET_TYPE_CONNECT = 1, MQTT_PACKET_TYPE_CONNACK = 2, MQTT_PACKET_TYPE_PUBLISH = 3,
  MQTT_PACKET_TYPE_PUBACK = 4, MQTT_PACKET_TYPE_PUBREC = 5, MQTT_PACKET_TYPE_PUBREL = 6, MQTT_PACKET_TYPE_PUBCOMP = 7,
  MQTT_PACKET_TYPE_SUBSCRIBE = 8, MQTT_PACKET_TYPE_SUBACK = 9, MQTT_PACKET_TYPE_UNSUBSCRIBE = 10, MQTT_PACKET_TYPE_UNSUBACK = 11,
  MQTT_PACKET_TYPE_PINGREQ = 12, MQTT_PACKET_TYPE_PINGRESP = 13, MQTT_PACKET_TYPE_DISCONNECT = 14
}
 MQTT control packet type. More...
 
enum  MqttConnectFlags {
  MQTT_CONNECT_FLAG_CLEAN_SESSION = 0x02, MQTT_CONNECT_FLAG_WILL = 0x04, MQTT_CONNECT_FLAG_WILL_QOS_0 = 0x00, MQTT_CONNECT_FLAG_WILL_QOS_1 = 0x08,
  MQTT_CONNECT_FLAG_WILL_QOS_2 = 0x10, MQTT_CONNECT_FLAG_WILL_RETAIN = 0x20, MQTT_CONNECT_FLAG_PASSWORD = 0x40, MQTT_CONNECT_FLAG_USERNAME = 0x80
}
 Connect flags. More...
 
enum  MqttConnectAckFlags { MQTT_CONNECT_ACK_FLAG_SESSION_PRESENT = 0x01 }
 Connect Acknowledge flags. More...
 
enum  MqttConnectRetCode {
  MQTT_CONNECT_RET_CODE_ACCEPTED = 0, MQTT_CONNECT_RET_CODE_UNACCEPTABLE_VERSION = 1, MQTT_CONNECT_RET_CODE_ID_REJECTED = 2, MQTT_CONNECT_RET_CODE_SERVER_UNAVAILABLE = 3,
  MQTT_CONNECT_RET_CODE_BAD_USER_NAME = 4, MQTT_CONNECT_RET_CODE_NOT_AUTHORIZED = 5
}
 Connect return codes. More...
 

Detailed Description

Definitions common to MQTT client and server.

License

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

Copyright (C) 2010-2022 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.

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

Definition in file mqtt_common.h.

Macro Definition Documentation

◆ MQTT_MAX_HEADER_SIZE

#define MQTT_MAX_HEADER_SIZE   5

Definition at line 50 of file mqtt_common.h.

◆ MQTT_MIN_HEADER_SIZE

#define MQTT_MIN_HEADER_SIZE   2

Definition at line 48 of file mqtt_common.h.

◆ MQTT_PORT

#define MQTT_PORT   1883

Definition at line 38 of file mqtt_common.h.

◆ MQTT_PROTOCOL_NAME_3_1

#define MQTT_PROTOCOL_NAME_3_1   "MQIsdp"

Definition at line 43 of file mqtt_common.h.

◆ MQTT_PROTOCOL_NAME_3_1_1

#define MQTT_PROTOCOL_NAME_3_1_1   "MQTT"

Definition at line 45 of file mqtt_common.h.

◆ MQTT_TLS_PORT

#define MQTT_TLS_PORT   8883

Definition at line 40 of file mqtt_common.h.

Typedef Documentation

◆ MqttPacketHeader

typedef { ... } MqttPacketHeader

Fixed header.

◆ MqttString

typedef { ... } MqttString

UTF-8 encoded string.

Enumeration Type Documentation

◆ MqttConnectAckFlags

Connect Acknowledge flags.

Enumerator
MQTT_CONNECT_ACK_FLAG_SESSION_PRESENT 

Definition at line 139 of file mqtt_common.h.

◆ MqttConnectFlags

Connect flags.

Enumerator
MQTT_CONNECT_FLAG_CLEAN_SESSION 
MQTT_CONNECT_FLAG_WILL 
MQTT_CONNECT_FLAG_WILL_QOS_0 
MQTT_CONNECT_FLAG_WILL_QOS_1 
MQTT_CONNECT_FLAG_WILL_QOS_2 
MQTT_CONNECT_FLAG_WILL_RETAIN 
MQTT_CONNECT_FLAG_PASSWORD 
MQTT_CONNECT_FLAG_USERNAME 

Definition at line 122 of file mqtt_common.h.

◆ MqttConnectRetCode

Connect return codes.

Enumerator
MQTT_CONNECT_RET_CODE_ACCEPTED 
MQTT_CONNECT_RET_CODE_UNACCEPTABLE_VERSION 
MQTT_CONNECT_RET_CODE_ID_REJECTED 
MQTT_CONNECT_RET_CODE_SERVER_UNAVAILABLE 
MQTT_CONNECT_RET_CODE_BAD_USER_NAME 
MQTT_CONNECT_RET_CODE_NOT_AUTHORIZED 

Definition at line 149 of file mqtt_common.h.

◆ MqttPacketType

MQTT control packet type.

Enumerator
MQTT_PACKET_TYPE_INVALID 

Invalid packet.

MQTT_PACKET_TYPE_CONNECT 

Client request to connect to server.

MQTT_PACKET_TYPE_CONNACK 

Connect acknowledgment.

MQTT_PACKET_TYPE_PUBLISH 

Publish message.

MQTT_PACKET_TYPE_PUBACK 

Publish acknowledgment.

MQTT_PACKET_TYPE_PUBREC 

Publish received (assured delivery part 1)

MQTT_PACKET_TYPE_PUBREL 

Publish release (assured delivery part 2)

MQTT_PACKET_TYPE_PUBCOMP 

Publish complete (assured delivery part 3)

MQTT_PACKET_TYPE_SUBSCRIBE 

Client subscribe request.

MQTT_PACKET_TYPE_SUBACK 

Subscribe acknowledgment.

MQTT_PACKET_TYPE_UNSUBSCRIBE 

Unsubscribe request.

MQTT_PACKET_TYPE_UNSUBACK 

Unsubscribe acknowledgment.

MQTT_PACKET_TYPE_PINGREQ 

Ping request.

MQTT_PACKET_TYPE_PINGRESP 

Ping response.

MQTT_PACKET_TYPE_DISCONNECT 

Client is disconnecting.

Definition at line 98 of file mqtt_common.h.

◆ MqttQosLevel

Quality of service level.

Enumerator
MQTT_QOS_LEVEL_0 

At most once delivery.

MQTT_QOS_LEVEL_1 

At least once delivery.

MQTT_QOS_LEVEL_2 

Exactly once delivery.

Definition at line 86 of file mqtt_common.h.

◆ MqttTransportProtocol

Transport protocol.

Enumerator
MQTT_TRANSPORT_PROTOCOL_TCP 
MQTT_TRANSPORT_PROTOCOL_TLS 

TCP protocol.

MQTT_TRANSPORT_PROTOCOL_WS 

TLS protocol.

MQTT_TRANSPORT_PROTOCOL_WSS 

WebSocket protocol.

Definition at line 73 of file mqtt_common.h.

◆ MqttVersion

MQTT protocol level.

Enumerator
MQTT_VERSION_3_1 

MQTT version 3.1.

MQTT_VERSION_3_1_1 

MQTT version 3.1.1.

Definition at line 62 of file mqtt_common.h.

Variable Documentation

◆ data

uint8_t data[]

Definition at line 194 of file mqtt_common.h.

◆ dup

uint8_t dup

Definition at line 180 of file mqtt_common.h.

◆ length

uint16_t length

Definition at line 183 of file mqtt_common.h.

◆ qos

uint8_t qos

Definition at line 179 of file mqtt_common.h.

◆ retain

uint8_t retain

Definition at line 178 of file mqtt_common.h.

◆ type

uint8_t type

Definition at line 181 of file mqtt_common.h.