Sergey Pastor / 1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

mqtt_common.h File Reference
Enumerations

mqtt_common.h File Reference

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

Go to the source code of this file.

Enumerations

enum  MqttProtocolLevel { MQTT_PROTOCOL_LEVEL_3_1 = 3, MQTT_PROTOCOL_LEVEL_3_1_1 = 4 }
 

MQTT protocol level.

More...
enum  MqttTransportProtocol { , 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
 

Connect flags.

More...
enum  MqttConnectAckFlags
 

Connect Acknowledge flags.

More...
enum  MqttConnectRetCode
 

Connect return codes.

More...

Detailed Description

Definitions common to MQTT client and server.

License

Copyright (C) 2010-2017 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:
1.7.6

Definition in file mqtt_common.h.

Enumeration Type Documentation

enum MqttConnectAckFlags

Connect Acknowledge flags.

Definition at line 132 of file mqtt_common.h.

enum MqttConnectFlags

Connect flags.

Definition at line 115 of file mqtt_common.h.

enum MqttConnectRetCode

Connect return codes.

Definition at line 142 of file mqtt_common.h.

enum 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 91 of file mqtt_common.h.

enum MqttProtocolLevel

MQTT protocol level.

Enumerator:
MQTT_PROTOCOL_LEVEL_3_1 

MQTT version 3.1.

MQTT_PROTOCOL_LEVEL_3_1_1 

MQTT version 3.1.1.

Definition at line 55 of file mqtt_common.h.

enum 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 79 of file mqtt_common.h.

enum MqttTransportProtocol

Transport protocol.

Enumerator:
MQTT_TRANSPORT_PROTOCOL_TLS 

TCP protocol.

MQTT_TRANSPORT_PROTOCOL_WS 

SSL protocol.

MQTT_TRANSPORT_PROTOCOL_WSS 

WebSocket protocol.

Definition at line 66 of file mqtt_common.h.

Generated on Tue Jul 12 2022 17:10:21 by  doxygen 1.7.2