![]() |
WL865E4-P
36.07.001
|
This section describes the M2MB APIs to perform various MQTT operations. More...
#define | M2MB_MQTT_MAX_SUBSCRIBE_HANDLERS 16 |
typedef VOID * | M2MB_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... | |
This section describes the M2MB APIs to perform various MQTT operations.
#define M2MB_MQTT_MAX_SUBSCRIBE_HANDLERS 16 |
Macro for maximum subscribe handlers
Definition at line 44 of file m2mb_mqtt.h.
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.
Definition at line 52 of file m2mb_mqtt.h.
typedef VOID(* M2MB_MQTT_CONNECT_CB_T) (M2MB_MQTT_CTXT_HANDLE handle, INT32 status) |
MQTT connect call back prototype.
Callback to return the client status.
Definition at line 59 of file m2mb_mqtt.h.
typedef VOID* M2MB_MQTT_CTXT_HANDLE |
MQTT context handle.
This is obtained from m2mb_mqtt_connect API and then used in subsequent MQTT APIs.
Definition at line 48 of file m2mb_mqtt.h.
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.
Subscribe callback.
Definition at line 65 of file m2mb_mqtt.h.
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.
m2mb_mqtt_con_params_create stores the configuration set by user. This configuration is used when mqtt connect API is called.
[out] | connect_params | pointer to connection parameters to be used in subsequent MQTT APIs. |
[in] | client_id | client id. |
[in] | host | host name. |
[in] | port | port number. |
[in] | keepalive_in_sec | keep alive time in seconds. |
Example
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.
m2mb_mqtt_conn_params_delete is called to delete all configured parameters.
[in] | connect_params | pointer to connection parameters obtained from m2mb_mqtt_con_params_create API. |
Example
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.
m2mb_mqtt_conn_params_set_connectCallback stores the configuration set by user. THis call back API gets called for asynchronous connection events.
[in] | connect_params | Pointer to connection parameters obtained from m2mb_mqtt_con_params_create API. |
[in] | callback | Call back API. |
[in] | callback_args | Callback arguments. |
Example
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.
m2mb_mqtt_conn_params_set_ssl_cfg sets ssl configuration.
[in] | connect_params | pointer to connection parameters obtained from m2mb_mqtt_con_params_create API. |
[in] | ssl_cfg | ssl config. |
Example
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.
m2mb_mqtt_conn_params_set_timeout_in_sec stores the configuration set by user. THis configuration is used when mqtt connect API is called.
[in] | connect_params | pointer to connection parameters obtained from m2mb_mqtt_con_params_create API. |
[in] | timeout_in_sec | timeout in seconds. |
Example
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.
m2mb_mqtt_conn_params_set_username stores the username set by user. This configuration is used when mqtt connect API is called.
[in] | connect_params | pointer to connection parameters obtained from m2mb_mqtt_con_params_create API. |
[in] | username | username |
[in] | password | password |
Example
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.
m2mb_mqtt_con_params_create stores the configuration set by user. This configuration is used when MQTT connect API is called.
[in] | connect_params | Pointer to connection parameters obtained from m2mb_mqtt_con_params_create API. |
[in] | ca_file | ca file name. |
[in] | cert_file | certificate file name. |
Example
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.
m2mb_mqtt_connect is called connect to the server.
[out] | mqtt_handle | mqtt handle obtained from m2mb_mqtt_connect API. |
[in] | connect_params | pointer to connection parameters obtained from m2mb_mqtt_con_params_create API. |
Example
int m2mb_mqtt_disconnect | ( | M2MB_MQTT_CTXT_HANDLE | mqtt_handle | ) |
m2mb_mqtt_disconnect is called to disconnect to the server.
m2mb_mqtt_disconnect is called disconnect to the server.
[in] | mqtt_handle | mqtt handle obtained from m2mb_mqtt_connect API. |
Example
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.
m2mb_mqtt_publish Publishes a message on a given topic.
[out] | mqtt_handle | mqtt handle obtained from m2mb_mqtt_connect API. |
[in] | qos | Integer value 0, 1, or 2 indicating the QOS to be used for msg. |
[in] | retain | Set to TRUE to make the message retained. |
[in] | message_id | Message ID |
[in] | topic | Topic name |
[in] | data | Data |
[in] | data_len | Data length. |
Example
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.
m2mb_mqtt_subscribe Subscribes to one topic.
[out] | mqtt_handle | mqtt handle obtained from m2mb_mqtt_connect API. |
[in] | msg_id | message id |
[in] | topic | topic name |
[in] | qos | Integer value 0, 1, or 2 indicating the QOS to be used for msg. |
Example
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.
m2mb_mqtt_subscribe_handler_register unsubscribe to one topic.
[out] | mqtt_handle | mqtt handle obtained from m2mb_mqtt_connect API. |
[in] | topic | Topic name |
[in] | cbk | Call back API |
[in] | arg | Call back arguments |
Example
int m2mb_mqtt_unsubscribe | ( | M2MB_MQTT_CTXT_HANDLE | mqtt_handle, |
unsigned short | msg_id, | ||
const char * | topic | ||
) |
m2mb_mqtt_unsubscribe is called to unsubscribe.
m2mb_mqtt_unsubscribe unsubscribe to one topic.
[out] | mqtt_handle | mqtt handle obtained from m2mb_mqtt_connect API. |
[in] | msg_id | message id |
[in] | topic | topic name |
Example