pikapython/package/mqtt/MQTTConnect.h

/*******************************************************************************
 * Copyright (c) 2014, 2017 IBM Corp.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 *
 * The Eclipse Public License is available at
 *    http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 *   http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *    Ian Craggs - initial API and implementation and/or initial documentation
 *    Ian Craggs - add connack return code definitions
 *    Xiang Rong - 442039 Add makefile to Embedded C client
 *    Ian Craggs - fix for issue #64, bit order in connack response
 *******************************************************************************/

#ifndef MQTTCONNECT_H_
#define MQTTCONNECT_H_

enum connack_return_codes {
    MQTT_CONNECTION_ACCEPTED = 0,
    MQTT_UNNACCEPTABLE_PROTOCOL = 1,
    MQTT_CLIENTID_REJECTED = 2,
    MQTT_SERVER_UNAVAILABLE = 3,
    MQTT_BAD_USERNAME_OR_PASSWORD = 4,
    MQTT_NOT_AUTHORIZED = 5,
};

#if !defined(DLLImport)
#define DLLImport
#endif
#if !defined(DLLExport)
#define DLLExport
#endif

typedef union {
    unsigned char all; /**< all connect flags */
#if defined(REVERSED)
    struct {
        unsigned int username : 1;     /**< 3.1 user name */
        unsigned int password : 1;     /**< 3.1 password */
        unsigned int willRetain : 1;   /**< will retain setting */
        unsigned int willQoS : 2;      /**< will QoS value */
        unsigned int will : 1;         /**< will flag */
        unsigned int cleansession : 1; /**< clean session flag */
        unsigned int : 1;              /**< unused */
    } bits;
#else
    struct {
        unsigned int : 1;              /**< unused */
        unsigned int cleansession : 1; /**< cleansession flag */
        unsigned int will : 1;         /**< will flag */
        unsigned int willQoS : 2;      /**< will QoS value */
        unsigned int willRetain : 1;   /**< will retain setting */
        unsigned int password : 1;     /**< 3.1 password */
        unsigned int username : 1;     /**< 3.1 user name */
    } bits;
#endif
} MQTTConnectFlags; /**< connect flags byte */

/**
 * Defines the MQTT "Last Will and Testament" (LWT) settings for
 * the connect packet.
 */
typedef struct {
    /** The eyecatcher for this structure.  must be MQTW. */
    char struct_id[4];
    /** The version number of this structure.  Must be 0 */
    int struct_version;
    /** The LWT topic to which the LWT message will be published. */
    MQTTString topicName;
    /** The LWT payload. */
    MQTTString message;
    /**
     * The retained flag for the LWT message (see MQTTAsync_message.retained).
     */
    unsigned char retained;
    /**
     * The quality of service setting for the LWT message (see
     * MQTTAsync_message.qos and @ref qos).
     */
    char qos;
} MQTTPacket_willOptions;

#define MQTTPacket_willOptions_initializer \
    { {'M', 'Q', 'T', 'W'}, 0, {NULL, {0, NULL}}, {NULL, {0, NULL}}, 0, 0 }

typedef struct {
    /** The eyecatcher for this structure.  must be MQTC. */
    char struct_id[4];
    /** The version number of this structure.  Must be 0 */
    int struct_version;
    /** Version of MQTT to be used.  3 = 3.1 4 = 3.1.1
     */
    unsigned char MQTTVersion;
    MQTTString clientID;
    unsigned short keepAliveInterval;
    unsigned char cleansession;
    unsigned char willFlag;
    MQTTPacket_willOptions will;
    MQTTString username;
    MQTTString password;
} MQTTPacket_connectData;

typedef union {
    unsigned char all; /**< all connack flags */
#if defined(REVERSED)
    struct {
        unsigned int reserved : 7;       /**< unused */
        unsigned int sessionpresent : 1; /**< session present flag */
    } bits;
#else
    struct {
        unsigned int sessionpresent : 1; /**< session present flag */
        unsigned int reserved : 7;       /**< unused */
    } bits;
#endif
} MQTTConnackFlags; /**< connack flags byte */

#define MQTTPacket_connectData_initializer                           \
    {                                                                \
        {'M', 'Q', 'T', 'C'}, 0, 4, {NULL, {0, NULL}}, 60, 1, 0,     \
            MQTTPacket_willOptions_initializer, {NULL, {0, NULL}}, { \
            NULL, {                                                  \
                0, NULL                                              \
            }                                                        \
        }                                                            \
    }

DLLExport int MQTTSerialize_connect(unsigned char* buf,
                                    int buflen,
                                    MQTTPacket_connectData* options);
DLLExport int MQTTDeserialize_connect(MQTTPacket_connectData* data,
                                      unsigned char* buf,
                                      int len);

DLLExport int MQTTSerialize_connack(unsigned char* buf,
                                    int buflen,
                                    unsigned char connack_rc,
                                    unsigned char sessionPresent);
DLLExport int MQTTDeserialize_connack(unsigned char* sessionPresent,
                                      unsigned char* connack_rc,
                                      unsigned char* buf,
                                      int buflen);

DLLExport int MQTTSerialize_disconnect(unsigned char* buf, int buflen);
DLLExport int MQTTSerialize_pingreq(unsigned char* buf, int buflen);

#endif /* MQTTCONNECT_H_ */