mqttclient.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ti_net_mqtt_MQTTClient__include
#define ti_net_mqtt_MQTTClient__include


//*****************************************************************************
// includes
//*****************************************************************************
#include <string.h>
#include <stdbool.h>
#include <ti/net/mqtt/common/mqtt_common.h>

#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
// defines
//*****************************************************************************

#define MQTTCLIENT_ERR_NETWORK     MQTT_PACKET_ERR_NETWORK  
#define MQTTCLIENT_ERR_TIMEOUT     MQTT_PACKET_ERR_TIMEOUT  
#define MQTTCLIENT_ERR_NET_OPS     MQTT_PACKET_ERR_NET_OPS  
#define MQTTCLIENT_ERR_FNPARAM     MQTT_PACKET_ERR_FNPARAM  
#define MQTTCLIENT_ERR_PKT_AVL     MQTT_PACKET_ERR_PKT_AVL  
#define MQTTCLIENT_ERR_PKT_LEN     MQTT_PACKET_ERR_PKT_LEN  
#define MQTTCLIENT_ERR_NOTCONN     MQTT_PACKET_ERR_NOTCONN  
#define MQTTCLIENT_ERR_BADCALL     MQTT_PACKET_ERR_BADCALL  
#define MQTTCLIENT_ERR_CONTENT     MQTT_PACKET_ERR_CONTENT  
#define MQTTCLIENT_ERR_LIBQUIT     MQTT_PACKET_ERR_LIBQUIT  
#define MQTTCLIENT_ERR_REMLSTN     MQTT_PACKET_ERR_REMLSTN  
#define MQTTCLIENT_OPERATION_CONNACK       MQTT_CONNACK     
#define MQTTCLIENT_OPERATION_EVT_PUBACK    MQTT_PUBACK      
#define MQTTCLIENT_OPERATION_PUBCOMP       MQTT_PUBCOMP     
#define MQTTCLIENT_OPERATION_SUBACK        MQTT_SUBACK      
#define MQTTCLIENT_OPERATION_UNSUBACK      MQTT_UNSUBACK    
#define MQTTCLIENT_NETCONN_IP4     MQTT_DEV_NETCONN_OPT_IP4   
#define MQTTCLIENT_NETCONN_IP6     MQTT_DEV_NETCONN_OPT_IP6   
#define MQTTCLIENT_NETCONN_URL     MQTT_DEV_NETCONN_OPT_URL   
#define MQTTCLIENT_NETCONN_SEC     MQTT_DEV_NETCONN_OPT_SEC   
#define MQTTCLIENT_NETCONN_SKIP_DOMAIN_NAME_VERIFICATION         MQTT_DEV_NETCONN_OPT_SKIP_DOMAIN_NAME_VERIFICATION          
#define MQTTCLIENT_NETCONN_SKIP_CERTIFICATE_CATALOG_VERIFICATION MQTT_DEV_NETCONN_OPT_SKIP_CERTIFICATE_CATALOG_VERIFICATION  
#define MQTTCLIENT_NETCONN_SKIP_DATE_VERIFICATION                MQTT_DEV_NETCONN_OPT_SKIP_DATE_VERIFICATION                 
//*****************************************************************************
// typedefs
//*****************************************************************************

typedef enum
{
    MQTTClient_USER_NAME      = 0,
    MQTTClient_PASSWORD       = 1,
    MQTTClient_WILL_PARAM     = 2,
    MQTTClient_CALLBACKS      = 3,
    MQTTClient_KEEPALIVE_TIME = 4,
    MQTTClient_CLEAN_CONNECT  = 5,
    MQTTClient_MAX_PARAM      = 6
} MQTTClient_Option;

/* callbacks   */

typedef enum
{
    MQTTClient_RECV_CB_EVENT       = 0,
    MQTTClient_OPERATION_CB_EVENT  = 1,
    MQTTClient_DISCONNECT_CB_EVENT = 2
} MQTTClient_EventCB;

typedef struct MQTTClient_OperationMetaDataCB
{
    uint32_t messageType;
} MQTTClient_OperationMetaDataCB;

typedef struct MQTTClient_RecvMetaDataCB
{
    const char *topic;
    int32_t topLen;
    bool dup;
    uint8_t qos;
    bool retain;
} MQTTClient_RecvMetaDataCB;


/*
 Note: value of n_files can vary from 1 to 4, with corresponding pointers to
 the files in files field. Value of 1(n_files) will assume the corresponding
 pointer is for CA File Name. Any other value of n_files expects the files to
 be in following order:
 1.  Private Key File
 2.  Certificate File Name
 3.  CA File Name
 4.  DH Key File Name

 example:
 If you want to provide only CA File Name, following are the two way of doing it:
 for n_files = 1
 char *security_file_list[] = {"/cert/testcacert.der"};
 for n_files = 4
 char *security_file_list[] = {NULL, NULL, "/cert/testcacert.der", NULL};

 where secure_files = security_file_list
 */

typedef struct MQTTClient_ConnParams
{
    uint32_t netconnFlags; 
    const char *serverAddr; 
    uint16_t port; 
    uint8_t method; 
    uint32_t cipher; 
    uint32_t nFiles; 
    char * const *secureFiles; /* SL needs 4 files*/
} MQTTClient_ConnParams;

typedef struct MQTTClient_Params
{
    char *clientId;

    bool mqttMode31;

    bool blockingSend;
    MQTTClient_ConnParams *connParams; 
} MQTTClient_Params;

typedef void (*MQTTClient_CallBack)(int32_t event, void *metaData, uint32_t metaDateLen, void *data, uint32_t dataLen);
typedef void *MQTTClient_Handle;

typedef struct MQTTClient_SubscribeParams
{
    char *topic;
    MQTTClient_CallBack callback; // optional - if NULL use the default callback
    uint8_t qos;
    uint8_t persistent;
} MQTTClient_SubscribeParams;

typedef struct MQTTClient_UnsubscribeParams
{
    char* topic;
    uint8_t persistent;
} MQTTClient_UnsubscribeParams;

/*  Data structure which holds a will data message. */

typedef struct MQTTClient_Will
{
    const char *willTopic; 
    const char *willMsg;   
    int8_t      willQos;   
    bool        retain;    
} MQTTClient_Will;

//*****************************************************************************
// function prototypes
//*****************************************************************************

MQTTClient_Handle MQTTClient_create(MQTTClient_CallBack defaultCallback,
        MQTTClient_Params *params);

int16_t MQTTClient_delete(MQTTClient_Handle handle);

int16_t MQTTClient_run(MQTTClient_Handle handle);

int16_t MQTTClient_connect(MQTTClient_Handle handle);

int16_t MQTTClient_disconnect(MQTTClient_Handle handle);

int16_t MQTTClient_publish(MQTTClient_Handle handle, char *topic, uint16_t topicLen, char *msg, uint16_t msgLen, uint32_t flags);

int16_t MQTTClient_subscribe(MQTTClient_Handle handle, MQTTClient_SubscribeParams *value, uint8_t numberOfTopics);

int16_t MQTTClient_unsubscribe(MQTTClient_Handle handle, MQTTClient_UnsubscribeParams *value, uint8_t numberOfTopics);

int16_t MQTTClient_set(MQTTClient_Handle handle, uint16_t option, void *value, uint16_t valueLength);

int16_t MQTTClient_get(MQTTClient_Handle handle, uint16_t option, void *value, uint16_t valueLength);

#ifdef __cplusplus
}
#endif

#endif