Ian Craggs / MQTTSNPacket

Low level MQTTSN packet library, part of the Eclipse Paho project: http://eclipse.org/paho

Dependents:   MQTTSN sara-n200-hello-mqtt-sn MQTTSN_2

The master source for this project is held at: https://github.com/eclipse/paho.mqtt-sn.embedded-c

MQTTSNDeserializePublish.c@1:7fa362fa563f, 2016-01-06 (annotated)

Committer:
icraggs
Date:
Wed Jan 06 14:19:27 2016 +0000
Revision:
1:7fa362fa563f
Parent:
0:c524a894b5e8 
Internal function name changes to avoid name clashes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
icraggs 1:7fa362fa563f 1 /*******************************************************************************
icraggs 1:7fa362fa563f 2 * Copyright (c) 2014 IBM Corp.
icraggs 1:7fa362fa563f 3 *
icraggs 1:7fa362fa563f 4 * All rights reserved. This program and the accompanying materials
icraggs 1:7fa362fa563f 5 * are made available under the terms of the Eclipse Public License v1.0
icraggs 1:7fa362fa563f 6 * and Eclipse Distribution License v1.0 which accompany this distribution.
icraggs 1:7fa362fa563f 7 *
icraggs 1:7fa362fa563f 8 * The Eclipse Public License is available at
icraggs 1:7fa362fa563f 9 * http://www.eclipse.org/legal/epl-v10.html
icraggs 1:7fa362fa563f 10 * and the Eclipse Distribution License is available at
icraggs 1:7fa362fa563f 11 * http://www.eclipse.org/org/documents/edl-v10.php.
icraggs 1:7fa362fa563f 12 *
icraggs 1:7fa362fa563f 13 * Contributors:
icraggs 1:7fa362fa563f 14 * Ian Craggs - initial API and implementation and/or initial documentation
icraggs 1:7fa362fa563f 15 *******************************************************************************/
icraggs 1:7fa362fa563f 16
icraggs 1:7fa362fa563f 17 #include "StackTrace.h"
icraggs 1:7fa362fa563f 18 #include "MQTTSNPacket.h"
icraggs 1:7fa362fa563f 19 #include <string.h>
icraggs 1:7fa362fa563f 20
icraggs 1:7fa362fa563f 21 #define min(a, b) ((a < b) ? 1 : 0)
icraggs 1:7fa362fa563f 22
icraggs 1:7fa362fa563f 23 /**
icraggs 1:7fa362fa563f 24 * Deserializes the supplied (wire) buffer into publish data
icraggs 1:7fa362fa563f 25 * @param dup returned integer - the MQTT dup flag
icraggs 1:7fa362fa563f 26 * @param qos returned integer - the MQTT QoS value
icraggs 1:7fa362fa563f 27 * @param retained returned integer - the MQTT retained flag
icraggs 1:7fa362fa563f 28 * @param packetid returned integer - the MQTT packet identifier
icraggs 1:7fa362fa563f 29 * @param topicName returned MQTTSNString - the MQTT topic in the publish
icraggs 1:7fa362fa563f 30 * @param payload returned byte buffer - the MQTT publish payload
icraggs 1:7fa362fa563f 31 * @param payloadlen returned integer - the length of the MQTT payload
icraggs 1:7fa362fa563f 32 * @param buf the raw buffer data, of the correct length determined by the remaining length field
icraggs 1:7fa362fa563f 33 * @param buflen the length in bytes of the data in the supplied buffer
icraggs 1:7fa362fa563f 34 * @return error code. 1 is success
icraggs 1:7fa362fa563f 35 */
icraggs 1:7fa362fa563f 36 int MQTTSNDeserialize_publish(unsigned char* dup, int* qos, unsigned char* retained, unsigned short* packetid, MQTTSN_topicid* topic,
icraggs 1:7fa362fa563f 37 unsigned char** payload, int* payloadlen, unsigned char* buf, int buflen)
icraggs 1:7fa362fa563f 38 {
icraggs 1:7fa362fa563f 39 MQTTSNFlags flags;
icraggs 1:7fa362fa563f 40 unsigned char* curdata = buf;
icraggs 1:7fa362fa563f 41 unsigned char* enddata = NULL;
icraggs 1:7fa362fa563f 42 int rc = 0;
icraggs 1:7fa362fa563f 43 int mylen = 0;
icraggs 1:7fa362fa563f 44
icraggs 1:7fa362fa563f 45 FUNC_ENTRY;
icraggs 1:7fa362fa563f 46 curdata += (rc = MQTTSNPacket_decode(curdata, buflen, &mylen)); /* read length */
icraggs 1:7fa362fa563f 47 enddata = buf + mylen;
icraggs 1:7fa362fa563f 48 if (enddata - curdata > buflen)
icraggs 1:7fa362fa563f 49 goto exit;
icraggs 1:7fa362fa563f 50
icraggs 1:7fa362fa563f 51 if (MQTTSNPacket_readChar(&curdata) != MQTTSN_PUBLISH)
icraggs 1:7fa362fa563f 52 goto exit;
icraggs 1:7fa362fa563f 53
icraggs 1:7fa362fa563f 54 flags.all = MQTTSNPacket_readChar(&curdata);
icraggs 1:7fa362fa563f 55 *dup = flags.bits.dup;
icraggs 1:7fa362fa563f 56 *qos = flags.bits.QoS;
icraggs 1:7fa362fa563f 57 *retained = flags.bits.retain;
icraggs 1:7fa362fa563f 58
icraggs 1:7fa362fa563f 59 topic->type = flags.bits.topicIdType;
icraggs 1:7fa362fa563f 60 if (topic->type == MQTTSN_TOPIC_TYPE_NORMAL && *qos == 3)
icraggs 1:7fa362fa563f 61 {
icraggs 1:7fa362fa563f 62 /* special arrangement for long topic names in QoS -1 publishes. The length of the topic is in the topicid field */
icraggs 1:7fa362fa563f 63 topic->data.long_.len = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 64 }
icraggs 1:7fa362fa563f 65 else if (topic->type == MQTTSN_TOPIC_TYPE_NORMAL || topic->type == MQTTSN_TOPIC_TYPE_PREDEFINED)
icraggs 1:7fa362fa563f 66 topic->data.id = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 67 else
icraggs 1:7fa362fa563f 68 {
icraggs 1:7fa362fa563f 69 topic->data.short_name[0] = MQTTSNPacket_readChar(&curdata);
icraggs 1:7fa362fa563f 70 topic->data.short_name[1] = MQTTSNPacket_readChar(&curdata);
icraggs 1:7fa362fa563f 71 }
icraggs 1:7fa362fa563f 72 *packetid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 73
icraggs 1:7fa362fa563f 74 if (topic->type == MQTTSN_TOPIC_TYPE_NORMAL && *qos == 3)
icraggs 1:7fa362fa563f 75 {
icraggs 1:7fa362fa563f 76 topic->data.long_.name = (char*)curdata;
icraggs 1:7fa362fa563f 77 curdata += topic->data.long_.len;
icraggs 1:7fa362fa563f 78 }
icraggs 1:7fa362fa563f 79
icraggs 1:7fa362fa563f 80 *payloadlen = enddata - curdata;
icraggs 1:7fa362fa563f 81 *payload = curdata;
icraggs 1:7fa362fa563f 82 rc = 1;
icraggs 1:7fa362fa563f 83 exit:
icraggs 1:7fa362fa563f 84 FUNC_EXIT_RC(rc);
icraggs 1:7fa362fa563f 85 return rc;
icraggs 1:7fa362fa563f 86 }
icraggs 1:7fa362fa563f 87
icraggs 1:7fa362fa563f 88
icraggs 1:7fa362fa563f 89 int MQTTSNDeserialize_puback(unsigned short* topicid, unsigned short* packetid,
icraggs 1:7fa362fa563f 90 unsigned char* returncode, unsigned char* buf, int buflen)
icraggs 1:7fa362fa563f 91 {
icraggs 1:7fa362fa563f 92 unsigned char* curdata = buf;
icraggs 1:7fa362fa563f 93 unsigned char* enddata = NULL;
icraggs 1:7fa362fa563f 94 int rc = 0;
icraggs 1:7fa362fa563f 95 int mylen = 0;
icraggs 1:7fa362fa563f 96
icraggs 1:7fa362fa563f 97 FUNC_ENTRY;
icraggs 1:7fa362fa563f 98 curdata += (rc = MQTTSNPacket_decode(curdata, buflen, &mylen)); /* read length */
icraggs 1:7fa362fa563f 99 enddata = buf + mylen;
icraggs 1:7fa362fa563f 100 if (enddata - curdata > buflen)
icraggs 1:7fa362fa563f 101 goto exit;
icraggs 1:7fa362fa563f 102
icraggs 1:7fa362fa563f 103 if (MQTTSNPacket_readChar(&curdata) != MQTTSN_PUBACK)
icraggs 1:7fa362fa563f 104 goto exit;
icraggs 1:7fa362fa563f 105
icraggs 1:7fa362fa563f 106 *topicid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 107 *packetid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 108 *returncode = MQTTSNPacket_readChar(&curdata);
icraggs 0:c524a894b5e8 109
icraggs 1:7fa362fa563f 110 rc = 1;
icraggs 1:7fa362fa563f 111 exit:
icraggs 1:7fa362fa563f 112 FUNC_EXIT_RC(rc);
icraggs 1:7fa362fa563f 113 return rc;
icraggs 1:7fa362fa563f 114 }
icraggs 1:7fa362fa563f 115
icraggs 1:7fa362fa563f 116
icraggs 1:7fa362fa563f 117 /**
icraggs 1:7fa362fa563f 118 * Deserializes the supplied (wire) buffer into an ack
icraggs 1:7fa362fa563f 119 * @param packettype returned integer - the MQTT packet type
icraggs 1:7fa362fa563f 120 * @param packetid returned integer - the MQTT packet identifier
icraggs 1:7fa362fa563f 121 * @param buf the raw buffer data, of the correct length determined by the remaining length field
icraggs 1:7fa362fa563f 122 * @param buflen the length in bytes of the data in the supplied buffer
icraggs 1:7fa362fa563f 123 * @return error code. 1 is success, 0 is failure
icraggs 1:7fa362fa563f 124 */
icraggs 1:7fa362fa563f 125 int MQTTSNDeserialize_ack(unsigned char* type, unsigned short* packetid, unsigned char* buf, int buflen)
icraggs 1:7fa362fa563f 126 {
icraggs 1:7fa362fa563f 127 unsigned char* curdata = buf;
icraggs 1:7fa362fa563f 128 unsigned char* enddata = NULL;
icraggs 1:7fa362fa563f 129 int rc = 0;
icraggs 1:7fa362fa563f 130 int mylen = 0;
icraggs 1:7fa362fa563f 131
icraggs 1:7fa362fa563f 132 FUNC_ENTRY;
icraggs 1:7fa362fa563f 133 curdata += (rc = MQTTSNPacket_decode(curdata, buflen, &mylen)); /* read length */
icraggs 1:7fa362fa563f 134 enddata = buf + mylen;
icraggs 1:7fa362fa563f 135 if (enddata - curdata > buflen)
icraggs 1:7fa362fa563f 136 goto exit;
icraggs 1:7fa362fa563f 137
icraggs 1:7fa362fa563f 138 *type = MQTTSNPacket_readChar(&curdata);
icraggs 1:7fa362fa563f 139 if (*type != MQTTSN_PUBREL && *type != MQTTSN_PUBREC && *type != MQTTSN_PUBCOMP)
icraggs 1:7fa362fa563f 140 goto exit;
icraggs 1:7fa362fa563f 141
icraggs 1:7fa362fa563f 142 *packetid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 143
icraggs 1:7fa362fa563f 144 rc = 1;
icraggs 1:7fa362fa563f 145 exit:
icraggs 1:7fa362fa563f 146 FUNC_EXIT_RC(rc);
icraggs 1:7fa362fa563f 147 return rc;
icraggs 1:7fa362fa563f 148 }
icraggs 1:7fa362fa563f 149
icraggs 1:7fa362fa563f 150
icraggs 1:7fa362fa563f 151 /**
icraggs 1:7fa362fa563f 152 * Deserializes the supplied (wire) buffer into register data
icraggs 1:7fa362fa563f 153 * @param topicid returned topic id
icraggs 1:7fa362fa563f 154 * @param packetid returned integer - the MQTT packet identifier
icraggs 1:7fa362fa563f 155 * @param topicName returned MQTTSNString - the MQTT topic in the register
icraggs 1:7fa362fa563f 156 * @param buf the raw buffer data, of the correct length determined by the remaining length field
icraggs 1:7fa362fa563f 157 * @param buflen the length in bytes of the data in the supplied buffer
icraggs 1:7fa362fa563f 158 * @return error code. 1 is success
icraggs 1:7fa362fa563f 159 */
icraggs 1:7fa362fa563f 160 int MQTTSNDeserialize_register(unsigned short* topicid, unsigned short* packetid, MQTTSNString* topicname,
icraggs 1:7fa362fa563f 161 unsigned char* buf, int buflen)
icraggs 1:7fa362fa563f 162 {
icraggs 1:7fa362fa563f 163 unsigned char* curdata = buf;
icraggs 1:7fa362fa563f 164 unsigned char* enddata = NULL;
icraggs 1:7fa362fa563f 165 int rc = 0;
icraggs 1:7fa362fa563f 166 int mylen = 0;
icraggs 1:7fa362fa563f 167
icraggs 1:7fa362fa563f 168 FUNC_ENTRY;
icraggs 1:7fa362fa563f 169 curdata += (rc = MQTTSNPacket_decode(curdata, buflen, &mylen)); /* read length */
icraggs 1:7fa362fa563f 170 enddata = buf + mylen;
icraggs 1:7fa362fa563f 171 if (enddata - curdata > buflen)
icraggs 1:7fa362fa563f 172 goto exit;
icraggs 1:7fa362fa563f 173
icraggs 1:7fa362fa563f 174 if (MQTTSNPacket_readChar(&curdata) != MQTTSN_REGISTER)
icraggs 1:7fa362fa563f 175 goto exit;
icraggs 1:7fa362fa563f 176
icraggs 1:7fa362fa563f 177 *topicid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 178 *packetid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 179
icraggs 1:7fa362fa563f 180 topicname->lenstring.data = (char*)curdata;
icraggs 1:7fa362fa563f 181 topicname->lenstring.len = enddata - curdata;
icraggs 1:7fa362fa563f 182 topicname->cstring = NULL;
icraggs 1:7fa362fa563f 183
icraggs 1:7fa362fa563f 184 rc = 1;
icraggs 1:7fa362fa563f 185 exit:
icraggs 1:7fa362fa563f 186 FUNC_EXIT_RC(rc);
icraggs 1:7fa362fa563f 187 return rc;
icraggs 1:7fa362fa563f 188 }
icraggs 1:7fa362fa563f 189
icraggs 1:7fa362fa563f 190
icraggs 1:7fa362fa563f 191 /**
icraggs 1:7fa362fa563f 192 * Deserializes the supplied (wire) buffer into register data
icraggs 1:7fa362fa563f 193 * @param topicid returned topic id
icraggs 1:7fa362fa563f 194 * @param packetid returned integer - the MQTT packet identifier
icraggs 1:7fa362fa563f 195 * @param return_code returned integer return code
icraggs 1:7fa362fa563f 196 * @param buf the raw buffer data, of the correct length determined by the remaining length field
icraggs 1:7fa362fa563f 197 * @param buflen the length in bytes of the data in the supplied buffer
icraggs 1:7fa362fa563f 198 * @return error code. 1 is success
icraggs 1:7fa362fa563f 199 */
icraggs 1:7fa362fa563f 200 int MQTTSNDeserialize_regack(unsigned short* topicid, unsigned short* packetid, unsigned char* return_code,
icraggs 1:7fa362fa563f 201 unsigned char* buf, int buflen)
icraggs 1:7fa362fa563f 202 {
icraggs 1:7fa362fa563f 203 unsigned char* curdata = buf;
icraggs 1:7fa362fa563f 204 unsigned char* enddata = NULL;
icraggs 1:7fa362fa563f 205 int rc = 0;
icraggs 1:7fa362fa563f 206 int mylen = 0;
icraggs 1:7fa362fa563f 207
icraggs 1:7fa362fa563f 208 FUNC_ENTRY;
icraggs 1:7fa362fa563f 209 curdata += (rc = MQTTSNPacket_decode(curdata, buflen, &mylen)); /* read length */
icraggs 1:7fa362fa563f 210 enddata = buf + mylen;
icraggs 1:7fa362fa563f 211 if (enddata - curdata > buflen)
icraggs 1:7fa362fa563f 212 goto exit;
icraggs 1:7fa362fa563f 213
icraggs 1:7fa362fa563f 214 if (MQTTSNPacket_readChar(&curdata) != MQTTSN_REGACK)
icraggs 1:7fa362fa563f 215 goto exit;
icraggs 1:7fa362fa563f 216
icraggs 1:7fa362fa563f 217 *topicid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 218 *packetid = MQTTSNPacket_readInt(&curdata);
icraggs 1:7fa362fa563f 219 *return_code = MQTTSNPacket_readChar(&curdata);
icraggs 1:7fa362fa563f 220
icraggs 1:7fa362fa563f 221 rc = 1;
icraggs 1:7fa362fa563f 222 exit:
icraggs 1:7fa362fa563f 223 FUNC_EXIT_RC(rc);
icraggs 1:7fa362fa563f 224 return rc;
icraggs 1:7fa362fa563f 225 }
icraggs 1:7fa362fa563f 226