m2mb_mqtt.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2MB_MQTT_H
#define  M2MB_MQTT_H

#include "m2mb_types.h"
#include "m2mb_status.h"

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
/* Global declarations ==========================================================================*/
#define M2MB_MQTT_MAX_SUBSCRIBE_TOPICS  32              
typedef VOID *  M2MB_MQTT_CTXT_HANDLE;

typedef enum M2MB_MQTT_SUBSCRIBE_REASON_E
{
    M2MB_MQTT_SUBSCRIPTION_DENIED = 0,          
    M2MB_MQTT_SUBSCRIPTION_GRANTED,             
    M2MB_MQTT_SUBSCRIPTION_MSG                          
}M2MB_MQTT_SUBSCRIBE_REASON_E;
typedef enum M2MB_MQTT_CONNECT_STATUS
{
        M2MB_MQTT_CONNECT_STATUS_UNKNOWN                                   = -1,
        M2MB_MQTT_CONNECT_STATUS_ACCEPTED                 = 0,
        M2MB_MQTT_CONNECT_STATUS_REFUSED_PROTOCOL_VERSION = 1,
        M2MB_MQTT_CONNECT_STATUS_REFUSED_IDENTIFIER       = 2,
        M2MB_MQTT_CONNECT_STATUS_REFUSED_SERVER           = 3,
        M2MB_MQTT_CONNECT_STATUS_REFUSED_USERNAME_PASS    = 4,
        M2MB_MQTT_CONNECT_STATUS_REFUSED_NOT_AUTHORIZED_  = 5,
        M2MB_MQTT_CONNECT_STATUS_DISCONNECTED             = 256,
        M2MB_MQTT_CONNECT_STATUS_TIMEOUT                  = 257
} M2MB_MQTT_CONNECT_STATUS_E;

typedef VOID (*M2MB_MQTT_CONNECT_CB_T) (M2MB_MQTT_CTXT_HANDLE handle, INT32 status);
typedef VOID (*M2MB_MQTT_MSG_HNDLR_CB_T) (M2MB_MQTT_CTXT_HANDLE handle, void* arg, 
        INT32 reason, const UINT8* topic, UINT16 topic_Length, const UINT8* msg, UINT32 msg_Length, UINT32 QOS );
typedef struct M2MB_MQTT_OPEN_PARAMS
{
        char *client_id;                                                
        UINT32 clean_session;                                   
        char *username;                                                 
        char *password;                                                 
        unsigned short keepalive_in_sec;                
        unsigned short timeout_in_sec;                  
        const char* will_topic;                                 
        const char* will_msg;                                   
        char will_qos;                                                  
        char will_retain;                                               
        void* pSslCfg;                                                  
}M2MB_MQTT_OPEN_PARAMS_T;

typedef struct M2MB_MQTT_CONN_PARAMS
{
        char *host;                                                             
        long port;                                                              
        BOOLEAN use_ssl;                                                
        M2MB_MQTT_CONNECT_CB_T connectcb;               
        void *connectcb_args;                                   
}M2MB_MQTT_CONN_PARAMS_T;

M2MB_STATUS_T m2mb_mqtt_init(VOID);
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_deinit(VOID);
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_open( M2MB_MQTT_CTXT_HANDLE *handle, M2MB_MQTT_OPEN_PARAMS_T* p_open_params);
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_close(M2MB_MQTT_CTXT_HANDLE mqtt_handle);
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_connect(M2MB_MQTT_CTXT_HANDLE mqtt_handle, M2MB_MQTT_CONN_PARAMS_T* p_conn_params);
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_disconnect(M2MB_MQTT_CTXT_HANDLE mqtt_handle);
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_publish(M2MB_MQTT_CTXT_HANDLE mqtt_handle, INT32 qos, INT32 retain, UINT16 message_id, const UINT8 *topic, const UINT8 *data, INT32 data_len);
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_subscribe(M2MB_MQTT_CTXT_HANDLE mqtt_handle, UINT16 msg_id, const UINT8 *topic, INT32 qos, M2MB_MQTT_MSG_HNDLR_CB_T cbk, VOID *cbk_arg);
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mqtt_unsubscribe(M2MB_MQTT_CTXT_HANDLE mqtt_handle, UINT16 msg_id, const UINT8 *topic);
/*-----------------------------------------------------------------------------------------------*/
#endif /*M2MB_MQTT_H*/