m2mb_mqtt.h

Go to the documentation of this file.

/* $version: 252422_R1  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2M_M2MB_MQTT_API_H
#define  M2M_M2MB_MQTT_API_H
 
/*-----------------------------------------------------------------------------------------------*/
 
/* Global declarations ==========================================================================*/
 
/*-----------------------------------------------------------------------------------------------
  m2mb_mqtt_conf can be used without CMDS like below
  m2mb_mqtt_conf_( handle, M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" )
 -----------------------------------------------------------------------------------------------*/
#define m2mb_mqtt_conf_( h,args,... )        m2mb_mqtt_conf( h, CMDS( args ) )
 
/* Global typedef ==========================================================================*/
 
typedef HANDLE  M2MB_MQTT_HANDLE;
 
typedef enum
{
  M2MB_MQTT_INDICATION_DISCONNECT
} M2MB_MQTT_IND_E;
 
typedef enum
{
  M2MB_MQTT_SUCCESS = 0,                
  M2MB_MQTT_ERROR_BAD_ARG = -1,         
  M2MB_MQTT_ERROR_OUT_OF_BUFFER = -2,   
  M2MB_MQTT_ERROR_MALFORMED_DATA = -3,  
  M2MB_MQTT_ERROR_PACKET_TYPE = -4,     
  M2MB_MQTT_ERROR_PACKET_ID = -5,       
  M2MB_MQTT_ERROR_TLS_CONNECT = -6,     
  M2MB_MQTT_ERROR_TIMEOUT = -7,         
  M2MB_MQTT_ERROR_NETWORK = -8,         
  M2MB_MQTT_ERROR_MEMORY = -9,          
  M2MB_MQTT_ERROR_STAT = -10,           
  M2MB_MQTT_ERROR_PROPERTY = -11,       
  M2MB_MQTT_ERROR_SERVER_PROP = -12,    
  M2MB_MQTT_ERROR_CALLBACK = -13,       
  M2MB_MQTT_ERROR_SEM = -14            ,
  M2MB_MQTT_ERROR_TOPIC_LIST = -15,    
  M2MB_MQTT_ERROR_ASYNC_THREAD = -16,   
  M2MB_MQTT_ERROR_QUEUE = -17,          
  M2MB_MQTT_ERROR_EVENT = -18,          
  M2MB_MQTT_PROTOCOL_UNSUPPORTED = -51, 
  M2MB_MQTT_IDENTIFIER_REJECTED = -52,  
  M2MB_MQTT_SERVER_UNAVAILABLE = -53,   
  M2MB_MQTT_BAD_USER_PASS = -54,        
  M2MB_MQTT_NOT_AUTHORISED = -55,       
  M2MB_MQTT_CONTINUE = -101,            
  M2MB_MQTT_STDIN_WAKE = -102,          
  M2MB_MQTT_ERROR_NOT_SUPPORTED = -201  
} M2MB_MQTT_RESPONSE_E;
 
typedef enum
{
 
  M2MB_MQTT_NOT_CONNECTED,            
  M2MB_MQTT_CLIENT_CONNECTED,         
  M2MB_MQTT_CONN_RESET_BY_PEER,       
  M2MB_MQTT_PINGREQ_TIMEOUT_FAIL,     
  M2MB_MQTT_CONNACK_TIMEOUT,          
  M2MB_MQTT_CONNECT_TIMEOUT,          
  M2MB_MQTT_FATAL_ERROR,              
  M2MB_MQTT_NETWORK_ERROR,            
  M2MB_MQTT_STATUS_DISCONNECT_INITIATED,
  M2MB_MQTT_STATUS_UNKNOWN = 0xFF,    
} M2MB_MQTT_STATUS_E;
 
typedef enum
{
 
  M2MB_MQTT_SET_CLIENT_ID,
  M2MB_MQTT_SET_TIMEOUT_MS,
  M2MB_MQTT_SECURE_OPT,
  M2MB_MQTT_SET_KEEPALIVE_SEC,
  M2MB_MQTT_SET_CLEAN_SESSION,
  M2MB_MQTT_SET_PROTOCOL_LEVEL,
  M2MB_MQTT_SET_LAST_WILL,
  M2MB_MQTT_SET_USERNAME,
  M2MB_MQTT_SET_PASSWORD,
  M2MB_MQTT_SET_PDP_CONTEXT,
  M2MB_MQTT_GET_CLIENT_ID,
  M2MB_MQTT_GET_TIMEOUT_MS,
  M2MB_MQTT_GET_KEEPALIVE_SEC,
  M2MB_MQTT_GET_CLEAN_SESSION,
  M2MB_MQTT_GET_PROTOCOL_LEVEL,
  M2MB_MQTT_GET_LAST_WILL,
  M2MB_MQTT_GET_PDP_CONTEXT,
  M2MB_MQTT_SET_PDP_HANDLE,
   M2MB_MQTT_SET_TCP_WINDOW,
   M2MB_MQTT_SET_TCP_WINDOWSCALE,
   M2MB_MQTT_SET_TCP_SACK,
   M2MB_MQTT_SET_TCP_MSS,
   M2MB_MQTT_MAX_CONF = 0x3F,
 
}M2MB_MQTT_ACTION_E;
 
typedef enum
{
  M2MB_MQTT_QOS_0 = 0,    
  M2MB_MQTT_QOS_1 = 1,    
  M2MB_MQTT_QOS_2 = 2,    
} M2MB_MQTT_QOS_E;
 
typedef enum
{
  M2MB_MQTT_RX_FINISHED,   
  M2MB_MQTT_RX_MORE_DATA,  
} M2MB_MQTT_RX_STATUS_E;
 
/*-----------------------------------------------------------------------------------------------*/
typedef void ( *m2mb_mqtt_ind_callback ) ( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
/*-----------------------------------------------------------------------------------------------*/
typedef void ( *M2MB_MQTT_MSG_HNDLR_CB_T ) ( M2MB_MQTT_HANDLE Handle, void* arg, const CHAR* topic,
              UINT16 topic_length, const CHAR* msg, UINT32 msg_length, M2MB_MQTT_RX_STATUS_E status );
 
typedef struct M2MB_MQTT_TOPIC
{
  const CHAR* topic_filter;     
  M2MB_MQTT_QOS_E qos;          
  M2MB_MQTT_MSG_HNDLR_CB_T cb;  
  void* arg;
} M2MB_MQTT_TOPIC_T;
 
 
/* Global functions =============================================================================*/
 
/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_init( M2MB_MQTT_HANDLE *h, m2mb_mqtt_ind_callback callback, void *userdata );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_deinit( M2MB_MQTT_HANDLE Handle );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_conf( M2MB_MQTT_HANDLE Handle, UINT8 nCmds, ... );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_connect( M2MB_MQTT_HANDLE Handle, const CHAR *host, UINT32 port );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_disconnect( M2MB_MQTT_HANDLE Handle );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_publish( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_QOS_E qos, UINT8 retain, UINT16 message_id, const CHAR *topic, const CHAR *data, UINT32 data_len );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_subscribe( M2MB_MQTT_HANDLE Handle, UINT16 message_id, UINT32 topic_count, M2MB_MQTT_TOPIC_T *pTopics );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_unsubscribe( M2MB_MQTT_HANDLE Handle, UINT16 message_id, UINT32 topic_count, M2MB_MQTT_TOPIC_T *topics );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_ping( M2MB_MQTT_HANDLE Handle );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_getClientStatus( M2MB_MQTT_HANDLE handle, M2MB_MQTT_STATUS_E *status );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_setClientStatus( M2MB_MQTT_HANDLE handle, M2MB_MQTT_STATUS_E status );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTT_RESPONSE_E m2mb_mqtt_setMessageCb( M2MB_MQTT_HANDLE h, CHAR* topic_filter,
                                                           UINT32 topic_size, M2MB_MQTT_MSG_HNDLR_CB_T cb,
                                                           void* arg, UINT32 arg_size );
 
/*-----------------------------------------------------------------------------------------------*/
 
/*-----------------------------------------------------------------------------------------------*/
 
M2MB_MQTT_RESPONSE_E m2mb_mqtt_get_new_msg_status( M2MB_MQTT_HANDLE handle, UINT8 *new_msg_ind );
 
/*-----------------------------------------------------------------------------------------------*/
#endif /*M2MB_MQTT_API_H*/