m2mb_mqttsn.h

Go to the documentation of this file.

/* $version: 252203  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2M_M2MB_MQTTSN_API_H
#define  M2M_M2MB_MQTTSN_API_H
 
/*-----------------------------------------------------------------------------------------------*/
 
/* Global declarations ==========================================================================*/
 
/*-----------------------------------------------------------------------------------------------
  m2mb_mqttsn_conf can be used without CMDS like below
  m2mb_mqttsn_conf_(handle, M2MB_MQTTSN_SET_CLIENT_ID, "MQTTSN_demo")
 -----------------------------------------------------------------------------------------------*/
#define m2mb_mqttsn_conf_( h, args... )        m2mb_mqttsn_conf( h, CMDS( args ) )
 
/* Global typedef ==============================================================================*/
 
typedef HANDLE  M2MB_MQTTSN_HANDLE;
 
typedef enum
{
  M2MB_MQTTSN_INDICATION_DISCONNECT = 0,
   M2MB_MQTTSN_INDICATION_MESSAGE_RCV = 1,
  ENUM_TO_INT( M2MB_MQTTSN_IND_E )
} M2MB_MQTTSN_IND_E;
 
typedef enum
{
  M2MB_MQTTSN_SUCCESS = 0,                
  M2MB_MQTTSN_ERROR_BAD_ARG = -1,         
  M2MB_MQTTSN_ERROR_OUT_OF_BUFFER = -2,   
  M2MB_MQTTSN_ERROR_MALFORMED_DATA = -3,  
  M2MB_MQTTSN_ERROR_PACKET_TYPE = -4,     
  M2MB_MQTTSN_ERROR_PACKET_ID = -5,       
  M2MB_MQTTSN_ERROR_TIMEOUT = -7,         
  M2MB_MQTTSN_ERROR_NETWORK = -8,         
  M2MB_MQTTSN_ERROR_MEMORY = -9,          
  M2MB_MQTTSN_ERROR_STAT = -10,           
  M2MB_MQTTSN_ERROR_CALLBACK = -13,       
  M2MB_MQTTSN_ERROR_SEM = -14,            
  M2MB_MQTTSN_ERROR_ASYNC_THREAD = -16,   
  M2MB_MQTTSN_ERROR    = -100,            
  M2MB_MQTTSN_CONTINUE = -101,            
  ENUM_TO_INT( M2MB_MQTTSN_RESPONSE_E )
} M2MB_MQTTSN_RESPONSE_E;
 
typedef enum
{
 
  M2MB_MQTTSN_NOT_CONNECTED,            
  M2MB_MQTTSN_SOCKET_CONNECTED,         
  M2MB_MQTTSN_CLIENT_CONNECTED,         
  M2MB_MQTTSN_CONN_RESET_BY_PEER,       
  M2MB_MQTTSN_PINGREQ_TIMEOUT_FAIL,     
  M2MB_MQTTSN_CONNECT_TIMEOUT,          
  M2MB_MQTTSN_CLIENT_SLEEP,             
  M2MB_MQTTSN_CLIENT_AWAKE,             
  M2MB_MQTTSN_FATAL_ERROR,              
  M2MB_MQTTSN_NETWORK_ERROR,            
  M2MB_MQTTSN_STATUS_UNKNOWN = 0xFF,    
  ENUM_TO_INT( M2MB_MQTTSN_STATUS_E )
} M2MB_MQTTSN_STATUS_E;
 
typedef enum
{
 
  M2MB_MQTTSN_SET_CLIENT_ID,
  M2MB_MQTTSN_SET_TIMEOUT_MS,
  M2MB_MQTTSN_SECURE_OPT,
  M2MB_MQTTSN_SET_KEEPALIVE_SEC,
  M2MB_MQTTSN_SET_CLEAN_SESSION,
  M2MB_MQTTSN_SET_LAST_WILL,
  M2MB_MQTTSN_SET_PDP_CONTEXT,
  M2MB_MQTTSN_GET_CLIENT_ID,
  M2MB_MQTTSN_GET_TIMEOUT_MS,
  M2MB_MQTTSN_GET_KEEPALIVE_SEC,
  M2MB_MQTTSN_GET_CLEAN_SESSION,
  M2MB_MQTTSN_GET_LAST_WILL,
  M2MB_MQTTSN_GET_PDP_CONTEXT,
  ENUM_TO_INT( M2MB_MQTTSN_ACTION_E )
}M2MB_MQTTSN_ACTION_E;
 
typedef enum
{
  M2MB_MQTTSN_QOS_0 = 0,    
  M2MB_MQTTSN_QOS_1 = 1,    
  M2MB_MQTTSN_QOS_2 = 2,    
  M2MB_MQTTSN_QOS_3 = 3,    
  ENUM_TO_INT( M2MB_MQTTSN_QOS_E )
} M2MB_MQTTSN_QOS_E;
 
typedef enum
{
  M2MB_MQTTSN_TOPIC_ID_NORMAL = 0x0,    
  M2MB_MQTTSN_TOPIC_ID_PREDEF = 0x1,    
  M2MB_MQTTSN_TOPIC_ID_SHORT  = 0x2,    
  ENUM_TO_INT( M2MB_MQTTSN_TOPIC_ID_E )
}M2MB_MQTTSN_TOPIC_ID_E;
 
typedef enum
{
  M2MB_MQTTSN_RX_FINISHED,   
  M2MB_MQTTSN_RX_MORE_DATA,  
  ENUM_TO_INT( M2MB_MQTTSN_RX_STATUS_E )
} M2MB_MQTTSN_RX_STATUS_E;
 
typedef enum
{
  M2MB_MQTTSN_CODE_ACCEPTED      = 0x00,   
  M2MB_MQTTSN_CODE_CONGESTION    = 0x01,   
  M2MB_MQTTSN_CODE_INVTOPICNAME  = 0x02,   
  M2MB_MQTTSN_CODE_NOTSUPPORTED  = 0x03,   
  ENUM_TO_INT( M2MB_MQTTSN_CODE_E )
  /* 0x04 - 0xFF reserved */
}M2MB_MQTTSN_CODE_E;
 
typedef struct M2MB_MQTTSN_WILL
{
  UINT8 will;                 
  M2MB_MQTTSN_QOS_E qos;      
  UINT8 retain;               
  const CHAR* will_topic;     
  CHAR* will_msg;             
  UINT16 will_msg_len;        
}M2MB_MQTTSN_WILL_T;
 
typedef struct M2MB_MQTTSN_PUBLISH
{
  M2MB_MQTTSN_QOS_E qos;            
  UINT8 retain;                     
  M2MB_MQTTSN_TOPIC_ID_E topic_type;
  UINT16 topic;                     
  const CHAR * short_topic;         
  const CHAR *data;                 
  UINT32 data_len;                  
}M2MB_MQTTSN_PUBLISH_T;
 
typedef struct M2MB_MQTTSN_SUBSCRIBE
{
  M2MB_MQTTSN_QOS_E qos;             
  M2MB_MQTTSN_TOPIC_ID_E topic_type; 
  const CHAR * topic;                
  UINT16 topic_id;                   
}M2MB_MQTTSN_SUBSCRIBE_T;
 
typedef struct M2MB_MQTTSN_MESSAGE_CTX
{
  UINT8 topic_type;                 
  const CHAR* topic;                
  UINT16 topic_length;              
  const CHAR* msg;                  
  UINT32 msg_length;                
  M2MB_MQTTSN_RX_STATUS_E status;   
}M2MB_MQTTSN_MESSAGE_CTX_T;
 
/*-----------------------------------------------------------------------------------------------*/
typedef void ( *m2mb_mqttsn_ind_callback ) ( M2MB_MQTTSN_HANDLE Handle, M2MB_MQTTSN_IND_E event,
                                                   UINT16 resp_size, void *resp, void *userdata );
 
/* Global functions =============================================================================*/
 
/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_init( M2MB_MQTTSN_HANDLE *pHandle, m2mb_mqttsn_ind_callback callback,
                                                   void *userdata );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_deinit( M2MB_MQTTSN_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_conf( M2MB_MQTTSN_HANDLE handle, UINT8 nCmds, ... );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_socket( M2MB_MQTTSN_HANDLE handle, const CHAR *host, UINT32 port);
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_clean_socket( M2MB_MQTTSN_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_connect(M2MB_MQTTSN_HANDLE handle, UINT8* return_code);
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_disconnect(M2MB_MQTTSN_HANDLE handle);
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_register( M2MB_MQTTSN_HANDLE handle, const CHAR *topic,
                                                         UINT16* topic_id, UINT8* return_code);
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_publish( M2MB_MQTTSN_HANDLE handle,
                                                        M2MB_MQTTSN_PUBLISH_T publish,
                                                        UINT8* return_code );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_subscribe( M2MB_MQTTSN_HANDLE handle,
                                                           M2MB_MQTTSN_SUBSCRIBE_T subscribe,
                                                           UINT16* topic_id, UINT8* return_code );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_unsubscribe( M2MB_MQTTSN_HANDLE handle,
                                                              M2MB_MQTTSN_TOPIC_ID_E topic_type,
                                                              const CHAR * topic, UINT16 topic_id);
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_ping( M2MB_MQTTSN_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_enter_sleep( M2MB_MQTTSN_HANDLE handle, UINT16 duration );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_awake( M2MB_MQTTSN_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_will_topic_update( M2MB_MQTTSN_HANDLE handle,
                                                                        M2MB_MQTTSN_WILL_T* will,
                                                                        UINT8* return_code );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_will_message_update( M2MB_MQTTSN_HANDLE handle,
                                                                           CHAR* will_msg,
                                                                           UINT16 will_msg_len,
                                                                           UINT8* return_code );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_MQTTSN_RESPONSE_E m2mb_mqttsn_get_client_status( M2MB_MQTTSN_HANDLE handle,
                                                      M2MB_MQTTSN_STATUS_E* status );
 
/*-----------------------------------------------------------------------------------------------*/
 
#endif /* M2MB_MQTTSN_API_H */