WL865E4-P  36.07.001
m2mb_mqtt.h File Reference

MQTT (Message Queuing Telemetry Transport) Client service. More...

Go to the source code of this file.

#define M2MB_MQTT_MAX_SUBSCRIBE_HANDLERS   16
 
typedef VOIDM2MB_MQTT_CTXT_HANDLE
 MQTT context handle.
This is obtained from m2mb_mqtt_connect API and then used in subsequent MQTT APIs. More...
 
typedef HANDLE M2MB_MQTT_CONN_PARAMS_HANDLE
 MQTT connection parameters handle.
This is obtained from m2mb_mqtt_con_params_create API and then used in subsequent MQTT APIs. More...
 
typedef VOID(* M2MB_MQTT_CONNECT_CB_T) (M2MB_MQTT_CTXT_HANDLE handle, INT32 status)
 MQTT connect call back prototype. More...
 
typedef VOID(* M2MB_MQTT_MSG_HNDLR_CB_T) (M2MB_MQTT_CTXT_HANDLE handle, void *arg, INT32 reason, const char *topic, UINT16 topic_Length, const char *msg, UINT32 msg_Length, UINT32 QOS)
 MQTT message handler call back prototype. More...
 
INT32 m2mb_mqtt_con_params_create (M2MB_MQTT_CONN_PARAMS_HANDLE *connect_params, const char *client_id, const char *host, long port, unsigned short keepalive_in_sec)
 m2mb_mqtt_con_params_create is called to create the connection parameters. More...
 
INT32 m2mb_mqtt_conn_params_set_username (M2MB_MQTT_CONN_PARAMS_HANDLE connect_params, const char *username, const char *password)
 m2mb_mqtt_conn_params_set_username is called to set the username. More...
 
M2MB_STATUS_T m2mb_mqtt_conn_params_set_timeout_in_sec (M2MB_MQTT_CONN_PARAMS_HANDLE connect_params, unsigned short timeout_in_sec)
 m2mb_mqtt_conn_params_set_timeout_in_sec is called to set timeout. More...
 
M2MB_STATUS_T m2mb_mqtt_conn_params_set_ssl_cfg (M2MB_MQTT_CONN_PARAMS_HANDLE connect_params, void *ssl_cfg)
 m2mb_mqtt_conn_params_set_ssl_cfg is called to set ssl config. More...
 
M2MB_STATUS_T m2mb_mqtt_conn_params_set_connectCallback (M2MB_MQTT_CONN_PARAMS_HANDLE connect_params, void *callback, void *callback_args)
 m2mb_mqtt_conn_params_set_connectCallback is called to to set call back API. More...
 
M2MB_STATUS_T m2mb_mqtt_conn_params_use_ssl (M2MB_MQTT_CONN_PARAMS_HANDLE connect_params, char *ca_file, char *cert_file)
 m2mb_mqtt_con_params_create is called to create the connection parameters. More...
 
INT32 m2mb_mqtt_conn_params_delete (M2MB_MQTT_CONN_PARAMS_HANDLE connect_params)
 m2mb_mqtt_conn_params_delete is called to delete all configured parameters. More...
 
INT32 m2mb_mqtt_connect (M2MB_MQTT_CTXT_HANDLE *mqtt_handle, M2MB_MQTT_CONN_PARAMS_HANDLE connect_params)
 m2mb_mqtt_connect is called to connect to the server. More...
 
int m2mb_mqtt_disconnect (M2MB_MQTT_CTXT_HANDLE mqtt_handle)
 m2mb_mqtt_disconnect is called to disconnect to the server. More...
 
int m2mb_mqtt_publish (M2MB_MQTT_CTXT_HANDLE mqtt_handle, int qos, int retain, unsigned short message_id, const char *topic, const char *data, int data_len)
 m2mb_mqtt_publish is called to Publishes a message. More...
 
int m2mb_mqtt_subscribe (M2MB_MQTT_CTXT_HANDLE mqtt_handle, unsigned short msg_id, const char *topic, int qos)
 m2mb_mqtt_subscribe is called to Subscribe. More...
 
int m2mb_mqtt_unsubscribe (M2MB_MQTT_CTXT_HANDLE mqtt_handle, unsigned short msg_id, const char *topic)
 m2mb_mqtt_unsubscribe is called to unsubscribe. More...
 
INT32 m2mb_mqtt_subscribe_handler_register (M2MB_MQTT_CTXT_HANDLE mqtt_handle, const char *topic, M2MB_MQTT_MSG_HNDLR_CB_T cbk, VOID *arg)
 m2mb_mqtt_subscribe_handler_register is called to unsubscribe. More...
 

Detailed Description

MQTT (Message Queuing Telemetry Transport) Client service.

we866e4/epl/inc/nwk/m2m_mqtt.h

The MQTT (Message Queuing Telemetry Transport) Client service provides a collection of APIs that allow the application to implement client functionalities, such as CONNECT, SUBSCRIBE, UNSUBSCRIBE, PUBLISH, DISCONNECT, and so on.

Note
Dependencies: m2mb_types.h
Author
Oshin Bhatia
Date
12/12/2017

Definition in file m2mb_mqtt.h.