IBM Watson IoT / Mbed OS IBMIoTClientEthernetExample

Contains example code to connect the mbed LPC1768 or FRDM-K64F devices to the IBM Internet of Things Cloud service via ethernet.

Dependencies:   C12832 MQTT LM75B MMA7660

Dependents:   MFT_IoT_demo_USB400 IBM_RFID

MQTT/MQTTPacket/MQTTConnectClient.c@6:37b6d0d56190, 2014-08-20 (annotated)

Committer:
samdanbury
Date:
Wed Aug 20 12:45:14 2014 +0000
Revision:
6:37b6d0d56190
Code completely changed to improve the structure, flow and memory usage of the application

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samdanbury 6:37b6d0d56190 1 /*******************************************************************************
samdanbury 6:37b6d0d56190 2 * Copyright (c) 2014 IBM Corp.
samdanbury 6:37b6d0d56190 3 *
samdanbury 6:37b6d0d56190 4 * All rights reserved. This program and the accompanying materials
samdanbury 6:37b6d0d56190 5 * are made available under the terms of the Eclipse Public License v1.0
samdanbury 6:37b6d0d56190 6 * and Eclipse Distribution License v1.0 which accompany this distribution.
samdanbury 6:37b6d0d56190 7 *
samdanbury 6:37b6d0d56190 8 * The Eclipse Public License is available at
samdanbury 6:37b6d0d56190 9 * http://www.eclipse.org/legal/epl-v10.html
samdanbury 6:37b6d0d56190 10 * and the Eclipse Distribution License is available at
samdanbury 6:37b6d0d56190 11 * http://www.eclipse.org/org/documents/edl-v10.php.
samdanbury 6:37b6d0d56190 12 *
samdanbury 6:37b6d0d56190 13 * Contributors:
samdanbury 6:37b6d0d56190 14 * Ian Craggs - initial API and implementation and/or initial documentation
samdanbury 6:37b6d0d56190 15 *******************************************************************************/
samdanbury 6:37b6d0d56190 16
samdanbury 6:37b6d0d56190 17 #include "MQTTPacket.h"
samdanbury 6:37b6d0d56190 18 #include "StackTrace.h"
samdanbury 6:37b6d0d56190 19
samdanbury 6:37b6d0d56190 20 #include <string.h>
samdanbury 6:37b6d0d56190 21
samdanbury 6:37b6d0d56190 22 /**
samdanbury 6:37b6d0d56190 23 * Determines the length of the MQTT connect packet that would be produced using the supplied connect options.
samdanbury 6:37b6d0d56190 24 * @param options the options to be used to build the connect packet
samdanbury 6:37b6d0d56190 25 * @return the length of buffer needed to contain the serialized version of the packet
samdanbury 6:37b6d0d56190 26 */
samdanbury 6:37b6d0d56190 27 int MQTTSerialize_connectLength(MQTTPacket_connectData* options)
samdanbury 6:37b6d0d56190 28 {
samdanbury 6:37b6d0d56190 29 int len = 0;
samdanbury 6:37b6d0d56190 30
samdanbury 6:37b6d0d56190 31 FUNC_ENTRY;
samdanbury 6:37b6d0d56190 32
samdanbury 6:37b6d0d56190 33 if (options->MQTTVersion == 3)
samdanbury 6:37b6d0d56190 34 len = 12; /* variable depending on MQTT or MQIsdp */
samdanbury 6:37b6d0d56190 35 else if (options->MQTTVersion == 4)
samdanbury 6:37b6d0d56190 36 len = 10;
samdanbury 6:37b6d0d56190 37
samdanbury 6:37b6d0d56190 38 len += MQTTstrlen(options->clientID)+2;
samdanbury 6:37b6d0d56190 39 if (options->willFlag)
samdanbury 6:37b6d0d56190 40 len += MQTTstrlen(options->will.topicName)+2 + MQTTstrlen(options->will.message)+2;
samdanbury 6:37b6d0d56190 41 if (options->username.cstring || options->username.lenstring.data)
samdanbury 6:37b6d0d56190 42 len += MQTTstrlen(options->username)+2;
samdanbury 6:37b6d0d56190 43 if (options->password.cstring || options->password.lenstring.data)
samdanbury 6:37b6d0d56190 44 len += MQTTstrlen(options->password)+2;
samdanbury 6:37b6d0d56190 45
samdanbury 6:37b6d0d56190 46 FUNC_EXIT_RC(len);
samdanbury 6:37b6d0d56190 47 return len;
samdanbury 6:37b6d0d56190 48 }
samdanbury 6:37b6d0d56190 49
samdanbury 6:37b6d0d56190 50
samdanbury 6:37b6d0d56190 51 /**
samdanbury 6:37b6d0d56190 52 * Serializes the connect options into the buffer.
samdanbury 6:37b6d0d56190 53 * @param buf the buffer into which the packet will be serialized
samdanbury 6:37b6d0d56190 54 * @param len the length in bytes of the supplied buffer
samdanbury 6:37b6d0d56190 55 * @param options the options to be used to build the connect packet
samdanbury 6:37b6d0d56190 56 * @return serialized length, or error if 0
samdanbury 6:37b6d0d56190 57 */
samdanbury 6:37b6d0d56190 58 int MQTTSerialize_connect(unsigned char* buf, int buflen, MQTTPacket_connectData* options)
samdanbury 6:37b6d0d56190 59 {
samdanbury 6:37b6d0d56190 60 unsigned char *ptr = buf;
samdanbury 6:37b6d0d56190 61 MQTTHeader header = {0};
samdanbury 6:37b6d0d56190 62 MQTTConnectFlags flags = {0};
samdanbury 6:37b6d0d56190 63 int len = 0;
samdanbury 6:37b6d0d56190 64 int rc = -1;
samdanbury 6:37b6d0d56190 65
samdanbury 6:37b6d0d56190 66 FUNC_ENTRY;
samdanbury 6:37b6d0d56190 67 if (MQTTPacket_len(len = MQTTSerialize_connectLength(options)) > buflen)
samdanbury 6:37b6d0d56190 68 {
samdanbury 6:37b6d0d56190 69 rc = MQTTPACKET_BUFFER_TOO_SHORT;
samdanbury 6:37b6d0d56190 70 goto exit;
samdanbury 6:37b6d0d56190 71 }
samdanbury 6:37b6d0d56190 72
samdanbury 6:37b6d0d56190 73 header.byte = 0;
samdanbury 6:37b6d0d56190 74 header.bits.type = CONNECT;
samdanbury 6:37b6d0d56190 75 writeChar(&ptr, header.byte); /* write header */
samdanbury 6:37b6d0d56190 76
samdanbury 6:37b6d0d56190 77 ptr += MQTTPacket_encode(ptr, len); /* write remaining length */
samdanbury 6:37b6d0d56190 78
samdanbury 6:37b6d0d56190 79 if (options->MQTTVersion == 4)
samdanbury 6:37b6d0d56190 80 {
samdanbury 6:37b6d0d56190 81 writeCString(&ptr, "MQTT");
samdanbury 6:37b6d0d56190 82 writeChar(&ptr, (char) 4);
samdanbury 6:37b6d0d56190 83 }
samdanbury 6:37b6d0d56190 84 else
samdanbury 6:37b6d0d56190 85 {
samdanbury 6:37b6d0d56190 86 writeCString(&ptr, "MQIsdp");
samdanbury 6:37b6d0d56190 87 writeChar(&ptr, (char) 3);
samdanbury 6:37b6d0d56190 88 }
samdanbury 6:37b6d0d56190 89
samdanbury 6:37b6d0d56190 90 flags.all = 0;
samdanbury 6:37b6d0d56190 91 flags.bits.cleansession = options->cleansession;
samdanbury 6:37b6d0d56190 92 flags.bits.will = (options->willFlag) ? 1 : 0;
samdanbury 6:37b6d0d56190 93 if (flags.bits.will)
samdanbury 6:37b6d0d56190 94 {
samdanbury 6:37b6d0d56190 95 flags.bits.willQoS = options->will.qos;
samdanbury 6:37b6d0d56190 96 flags.bits.willRetain = options->will.retained;
samdanbury 6:37b6d0d56190 97 }
samdanbury 6:37b6d0d56190 98
samdanbury 6:37b6d0d56190 99 if (options->username.cstring || options->username.lenstring.data)
samdanbury 6:37b6d0d56190 100 flags.bits.username = 1;
samdanbury 6:37b6d0d56190 101 if (options->password.cstring || options->password.lenstring.data)
samdanbury 6:37b6d0d56190 102 flags.bits.password = 1;
samdanbury 6:37b6d0d56190 103
samdanbury 6:37b6d0d56190 104 writeChar(&ptr, flags.all);
samdanbury 6:37b6d0d56190 105 writeInt(&ptr, options->keepAliveInterval);
samdanbury 6:37b6d0d56190 106 writeMQTTString(&ptr, options->clientID);
samdanbury 6:37b6d0d56190 107 if (options->willFlag)
samdanbury 6:37b6d0d56190 108 {
samdanbury 6:37b6d0d56190 109 writeMQTTString(&ptr, options->will.topicName);
samdanbury 6:37b6d0d56190 110 writeMQTTString(&ptr, options->will.message);
samdanbury 6:37b6d0d56190 111 }
samdanbury 6:37b6d0d56190 112 if (flags.bits.username)
samdanbury 6:37b6d0d56190 113 writeMQTTString(&ptr, options->username);
samdanbury 6:37b6d0d56190 114 if (flags.bits.password)
samdanbury 6:37b6d0d56190 115 writeMQTTString(&ptr, options->password);
samdanbury 6:37b6d0d56190 116
samdanbury 6:37b6d0d56190 117 rc = ptr - buf;
samdanbury 6:37b6d0d56190 118
samdanbury 6:37b6d0d56190 119 exit: FUNC_EXIT_RC(rc);
samdanbury 6:37b6d0d56190 120 return rc;
samdanbury 6:37b6d0d56190 121 }
samdanbury 6:37b6d0d56190 122
samdanbury 6:37b6d0d56190 123
samdanbury 6:37b6d0d56190 124 /**
samdanbury 6:37b6d0d56190 125 * Deserializes the supplied (wire) buffer into connack data - return code
samdanbury 6:37b6d0d56190 126 * @param sessionPresent the session present flag returned (only for MQTT 3.1.1)
samdanbury 6:37b6d0d56190 127 * @param connack_rc returned integer value of the connack return code
samdanbury 6:37b6d0d56190 128 * @param buf the raw buffer data, of the correct length determined by the remaining length field
samdanbury 6:37b6d0d56190 129 * @param len the length in bytes of the data in the supplied buffer
samdanbury 6:37b6d0d56190 130 * @return error code. 1 is success, 0 is failure
samdanbury 6:37b6d0d56190 131 */
samdanbury 6:37b6d0d56190 132 int MQTTDeserialize_connack(unsigned char* sessionPresent, unsigned char* connack_rc, unsigned char* buf, int buflen)
samdanbury 6:37b6d0d56190 133 {
samdanbury 6:37b6d0d56190 134 MQTTHeader header = {0};
samdanbury 6:37b6d0d56190 135 unsigned char* curdata = buf;
samdanbury 6:37b6d0d56190 136 unsigned char* enddata = NULL;
samdanbury 6:37b6d0d56190 137 int rc = 0;
samdanbury 6:37b6d0d56190 138 int mylen;
samdanbury 6:37b6d0d56190 139 MQTTConnackFlags flags = {0};
samdanbury 6:37b6d0d56190 140
samdanbury 6:37b6d0d56190 141 FUNC_ENTRY;
samdanbury 6:37b6d0d56190 142 header.byte = readChar(&curdata);
samdanbury 6:37b6d0d56190 143 if (header.bits.type != CONNACK)
samdanbury 6:37b6d0d56190 144 goto exit;
samdanbury 6:37b6d0d56190 145
samdanbury 6:37b6d0d56190 146 curdata += (rc = MQTTPacket_decodeBuf(curdata, &mylen)); /* read remaining length */
samdanbury 6:37b6d0d56190 147 enddata = curdata + mylen;
samdanbury 6:37b6d0d56190 148 if (enddata - curdata < 2)
samdanbury 6:37b6d0d56190 149 goto exit;
samdanbury 6:37b6d0d56190 150
samdanbury 6:37b6d0d56190 151 flags.all = readChar(&curdata);
samdanbury 6:37b6d0d56190 152 *sessionPresent = flags.bits.sessionpresent;
samdanbury 6:37b6d0d56190 153 *connack_rc = readChar(&curdata);
samdanbury 6:37b6d0d56190 154
samdanbury 6:37b6d0d56190 155 rc = 1;
samdanbury 6:37b6d0d56190 156 exit:
samdanbury 6:37b6d0d56190 157 FUNC_EXIT_RC(rc);
samdanbury 6:37b6d0d56190 158 return rc;
samdanbury 6:37b6d0d56190 159 }
samdanbury 6:37b6d0d56190 160
samdanbury 6:37b6d0d56190 161
samdanbury 6:37b6d0d56190 162
samdanbury 6:37b6d0d56190 163 /**
samdanbury 6:37b6d0d56190 164 * Serializes a 0-length packet into the supplied buffer, ready for writing to a socket
samdanbury 6:37b6d0d56190 165 * @param buf the buffer into which the packet will be serialized
samdanbury 6:37b6d0d56190 166 * @param buflen the length in bytes of the supplied buffer, to avoid overruns
samdanbury 6:37b6d0d56190 167 * @param packettype the message type
samdanbury 6:37b6d0d56190 168 * @return serialized length, or error if 0
samdanbury 6:37b6d0d56190 169 */
samdanbury 6:37b6d0d56190 170 int MQTTSerialize_zero(unsigned char* buf, int buflen, unsigned char packettype)
samdanbury 6:37b6d0d56190 171 {
samdanbury 6:37b6d0d56190 172 MQTTHeader header = {0};
samdanbury 6:37b6d0d56190 173 int rc = -1;
samdanbury 6:37b6d0d56190 174 unsigned char *ptr = buf;
samdanbury 6:37b6d0d56190 175
samdanbury 6:37b6d0d56190 176 FUNC_ENTRY;
samdanbury 6:37b6d0d56190 177 if (buflen < 2)
samdanbury 6:37b6d0d56190 178 {
samdanbury 6:37b6d0d56190 179 rc = MQTTPACKET_BUFFER_TOO_SHORT;
samdanbury 6:37b6d0d56190 180 goto exit;
samdanbury 6:37b6d0d56190 181 }
samdanbury 6:37b6d0d56190 182 header.byte = 0;
samdanbury 6:37b6d0d56190 183 header.bits.type = packettype;
samdanbury 6:37b6d0d56190 184 writeChar(&ptr, header.byte); /* write header */
samdanbury 6:37b6d0d56190 185
samdanbury 6:37b6d0d56190 186 ptr += MQTTPacket_encode(ptr, 0); /* write remaining length */
samdanbury 6:37b6d0d56190 187 rc = ptr - buf;
samdanbury 6:37b6d0d56190 188 exit:
samdanbury 6:37b6d0d56190 189 FUNC_EXIT_RC(rc);
samdanbury 6:37b6d0d56190 190 return rc;
samdanbury 6:37b6d0d56190 191 }
samdanbury 6:37b6d0d56190 192
samdanbury 6:37b6d0d56190 193
samdanbury 6:37b6d0d56190 194 /**
samdanbury 6:37b6d0d56190 195 * Serializes a disconnect packet into the supplied buffer, ready for writing to a socket
samdanbury 6:37b6d0d56190 196 * @param buf the buffer into which the packet will be serialized
samdanbury 6:37b6d0d56190 197 * @param buflen the length in bytes of the supplied buffer, to avoid overruns
samdanbury 6:37b6d0d56190 198 * @return serialized length, or error if 0
samdanbury 6:37b6d0d56190 199 */
samdanbury 6:37b6d0d56190 200 int MQTTSerialize_disconnect(unsigned char* buf, int buflen)
samdanbury 6:37b6d0d56190 201 {
samdanbury 6:37b6d0d56190 202 return MQTTSerialize_zero(buf, buflen, DISCONNECT);
samdanbury 6:37b6d0d56190 203 }
samdanbury 6:37b6d0d56190 204
samdanbury 6:37b6d0d56190 205
samdanbury 6:37b6d0d56190 206 /**
samdanbury 6:37b6d0d56190 207 * Serializes a disconnect packet into the supplied buffer, ready for writing to a socket
samdanbury 6:37b6d0d56190 208 * @param buf the buffer into which the packet will be serialized
samdanbury 6:37b6d0d56190 209 * @param buflen the length in bytes of the supplied buffer, to avoid overruns
samdanbury 6:37b6d0d56190 210 * @return serialized length, or error if 0
samdanbury 6:37b6d0d56190 211 */
samdanbury 6:37b6d0d56190 212 int MQTTSerialize_pingreq(unsigned char* buf, int buflen)
samdanbury 6:37b6d0d56190 213 {
samdanbury 6:37b6d0d56190 214 return MQTTSerialize_zero(buf, buflen, PINGREQ);
samdanbury 6:37b6d0d56190 215 }