MQTT / MQTTPacket

Basic C library for MQTT packet serialization and deserialization

Dependents:   MQTT MQTT MQTT MQTT ... more

Fork of MQTTPacket by MQTT

This library is part of the EclipseTM Paho project; specifically the embedded client.

A basic MQTT library in C for packet serialization and deserialization

MQTTConnect.h@16:d0b3886ada32, 2014-08-01 (annotated)

Committer:
icraggs
Date:
Fri Aug 01 16:58:18 2014 +0000
Revision:
16:d0b3886ada32
Parent:
14:c2052aee81de
Child:
20:63c71eeb4183
Add session present flag on connack

Who changed what in which revision?

UserRevisionLine numberNew contents of line
icraggs 0:7734401cc1b4 1 /*******************************************************************************
icraggs 0:7734401cc1b4 2 * Copyright (c) 2014 IBM Corp.
icraggs 0:7734401cc1b4 3 *
icraggs 0:7734401cc1b4 4 * All rights reserved. This program and the accompanying materials
icraggs 0:7734401cc1b4 5 * are made available under the terms of the Eclipse Public License v1.0
icraggs 0:7734401cc1b4 6 * and Eclipse Distribution License v1.0 which accompany this distribution.
icraggs 0:7734401cc1b4 7 *
icraggs 0:7734401cc1b4 8 * The Eclipse Public License is available at
icraggs 0:7734401cc1b4 9 * http://www.eclipse.org/legal/epl-v10.html
icraggs 0:7734401cc1b4 10 * and the Eclipse Distribution License is available at
icraggs 0:7734401cc1b4 11 * http://www.eclipse.org/org/documents/edl-v10.php.
icraggs 0:7734401cc1b4 12 *
icraggs 0:7734401cc1b4 13 * Contributors:
icraggs 0:7734401cc1b4 14 * Ian Craggs - initial API and implementation and/or initial documentation
icraggs 0:7734401cc1b4 15 *******************************************************************************/
icraggs 0:7734401cc1b4 16
icraggs 0:7734401cc1b4 17 #ifndef MQTTCONNECT_H_
icraggs 0:7734401cc1b4 18 #define MQTTCONNECT_H_
icraggs 0:7734401cc1b4 19
icraggs 0:7734401cc1b4 20 typedef union
icraggs 0:7734401cc1b4 21 {
icraggs 0:7734401cc1b4 22 unsigned char all; /**< all connect flags */
icraggs 0:7734401cc1b4 23 #if defined(REVERSED)
icraggs 0:7734401cc1b4 24 struct
icraggs 0:7734401cc1b4 25 {
icraggs 0:7734401cc1b4 26 unsigned int username : 1; /**< 3.1 user name */
icraggs 0:7734401cc1b4 27 unsigned int password : 1; /**< 3.1 password */
icraggs 0:7734401cc1b4 28 unsigned int willRetain : 1; /**< will retain setting */
icraggs 0:7734401cc1b4 29 unsigned int willQoS : 2; /**< will QoS value */
icraggs 0:7734401cc1b4 30 unsigned int will : 1; /**< will flag */
icraggs 0:7734401cc1b4 31 unsigned int cleansession : 1; /**< clean session flag */
icraggs 0:7734401cc1b4 32 unsigned int : 1; /**< unused */
icraggs 0:7734401cc1b4 33 } bits;
icraggs 0:7734401cc1b4 34 #else
icraggs 0:7734401cc1b4 35 struct
icraggs 0:7734401cc1b4 36 {
icraggs 0:7734401cc1b4 37 unsigned int : 1; /**< unused */
icraggs 0:7734401cc1b4 38 unsigned int cleansession : 1; /**< cleansession flag */
icraggs 0:7734401cc1b4 39 unsigned int will : 1; /**< will flag */
icraggs 0:7734401cc1b4 40 unsigned int willQoS : 2; /**< will QoS value */
icraggs 0:7734401cc1b4 41 unsigned int willRetain : 1; /**< will retain setting */
icraggs 0:7734401cc1b4 42 unsigned int password : 1; /**< 3.1 password */
icraggs 0:7734401cc1b4 43 unsigned int username : 1; /**< 3.1 user name */
icraggs 0:7734401cc1b4 44 } bits;
icraggs 0:7734401cc1b4 45 #endif
icraggs 0:7734401cc1b4 46 } MQTTConnectFlags; /**< connect flags byte */
icraggs 0:7734401cc1b4 47
icraggs 0:7734401cc1b4 48
icraggs 0:7734401cc1b4 49
icraggs 0:7734401cc1b4 50 /**
icraggs 0:7734401cc1b4 51 * Defines the MQTT "Last Will and Testament" (LWT) settings for
icraggs 0:7734401cc1b4 52 * the connect packet.
icraggs 0:7734401cc1b4 53 */
icraggs 0:7734401cc1b4 54 typedef struct
icraggs 0:7734401cc1b4 55 {
icraggs 0:7734401cc1b4 56 /** The eyecatcher for this structure. must be MQTW. */
icraggs 0:7734401cc1b4 57 char struct_id[4];
icraggs 0:7734401cc1b4 58 /** The version number of this structure. Must be 0 */
icraggs 0:7734401cc1b4 59 int struct_version;
icraggs 0:7734401cc1b4 60 /** The LWT topic to which the LWT message will be published. */
icraggs 0:7734401cc1b4 61 MQTTString topicName;
icraggs 0:7734401cc1b4 62 /** The LWT payload. */
icraggs 0:7734401cc1b4 63 MQTTString message;
icraggs 0:7734401cc1b4 64 /**
icraggs 0:7734401cc1b4 65 * The retained flag for the LWT message (see MQTTAsync_message.retained).
icraggs 0:7734401cc1b4 66 */
Ian Craggs 12:cd99ac9cb25a 67 unsigned char retained;
icraggs 0:7734401cc1b4 68 /**
icraggs 0:7734401cc1b4 69 * The quality of service setting for the LWT message (see
icraggs 0:7734401cc1b4 70 * MQTTAsync_message.qos and @ref qos).
icraggs 0:7734401cc1b4 71 */
Ian Craggs 14:c2052aee81de 72 char qos;
icraggs 0:7734401cc1b4 73 } MQTTPacket_willOptions;
icraggs 0:7734401cc1b4 74
icraggs 0:7734401cc1b4 75
icraggs 0:7734401cc1b4 76 #define MQTTPacket_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 0, {NULL, {0, NULL}}, {NULL, {0, NULL}}, 0, 0 }
icraggs 0:7734401cc1b4 77
icraggs 0:7734401cc1b4 78
icraggs 0:7734401cc1b4 79 typedef struct
icraggs 0:7734401cc1b4 80 {
icraggs 0:7734401cc1b4 81 /** The eyecatcher for this structure. must be MQTC. */
icraggs 0:7734401cc1b4 82 char struct_id[4];
icraggs 3:4a4f8699f935 83 /** The version number of this structure. Must be 0 */
icraggs 0:7734401cc1b4 84 int struct_version;
Ian Craggs 4:c502573c6016 85 /** Version of MQTT to be used. 3 = 3.1 4 = 3.1.1
Ian Craggs 4:c502573c6016 86 */
Ian Craggs 14:c2052aee81de 87 unsigned char MQTTVersion;
icraggs 0:7734401cc1b4 88 MQTTString clientID;
Ian Craggs 14:c2052aee81de 89 unsigned short keepAliveInterval;
Ian Craggs 12:cd99ac9cb25a 90 unsigned char cleansession;
Ian Craggs 12:cd99ac9cb25a 91 unsigned char willFlag;
icraggs 0:7734401cc1b4 92 MQTTPacket_willOptions will;
icraggs 0:7734401cc1b4 93 MQTTString username;
icraggs 0:7734401cc1b4 94 MQTTString password;
icraggs 0:7734401cc1b4 95 } MQTTPacket_connectData;
icraggs 0:7734401cc1b4 96
icraggs 16:d0b3886ada32 97 typedef union
icraggs 16:d0b3886ada32 98 {
icraggs 16:d0b3886ada32 99 unsigned char all; /**< all connack flags */
icraggs 16:d0b3886ada32 100 #if defined(REVERSED)
icraggs 16:d0b3886ada32 101 struct
icraggs 16:d0b3886ada32 102 {
icraggs 16:d0b3886ada32 103 unsigned int sessionpresent : 1; /**< session present flag */
icraggs 16:d0b3886ada32 104 unsigned int : y; /**< unused */
icraggs 16:d0b3886ada32 105 } bits;
icraggs 16:d0b3886ada32 106 #else
icraggs 16:d0b3886ada32 107 struct
icraggs 16:d0b3886ada32 108 {
icraggs 16:d0b3886ada32 109 unsigned int : 7; /**< unused */
icraggs 16:d0b3886ada32 110 unsigned int sessionpresent : 1; /**< session present flag */
icraggs 16:d0b3886ada32 111 } bits;
icraggs 16:d0b3886ada32 112 #endif
icraggs 16:d0b3886ada32 113 } MQTTConnackFlags; /**< connack flags byte */
icraggs 16:d0b3886ada32 114
icraggs 3:4a4f8699f935 115 #define MQTTPacket_connectData_initializer { {'M', 'Q', 'T', 'C'}, 0, 4, {NULL, {0, NULL}}, 60, 1, 0, \
icraggs 0:7734401cc1b4 116 MQTTPacket_willOptions_initializer, {NULL, {0, NULL}}, {NULL, {0, NULL}} }
icraggs 0:7734401cc1b4 117
Ian Craggs 14:c2052aee81de 118 int MQTTSerialize_connect(unsigned char* buf, int buflen, MQTTPacket_connectData* options);
Ian Craggs 14:c2052aee81de 119 int MQTTDeserialize_connect(MQTTPacket_connectData* data, unsigned char* buf, int len);
icraggs 0:7734401cc1b4 120
icraggs 16:d0b3886ada32 121 int MQTTSerialize_connack(unsigned char* buf, int buflen, unsigned char connack_rc, unsigned char sessionPresent);
icraggs 16:d0b3886ada32 122 int MQTTDeserialize_connack(unsigned char* sessionPresent, unsigned char* connack_rc, unsigned char* buf, int buflen);
icraggs 0:7734401cc1b4 123
Ian Craggs 14:c2052aee81de 124 int MQTTSerialize_disconnect(unsigned char* buf, int buflen);
Ian Craggs 14:c2052aee81de 125 int MQTTSerialize_pingreq(unsigned char* buf, int buflen);
icraggs 0:7734401cc1b4 126
icraggs 0:7734401cc1b4 127 #endif /* MQTTCONNECT_H_ */