MQTT client Open parameters. More...

#include <m2mb_mqtt.h>

Data Fields
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

Detailed Description

MQTT client Open parameters.

MQTT client open parameters used in m2mb_mqtt_open API.

Definition at line 192 of file m2mb_mqtt.h.

Field Documentation

◆ clean_session

UINT32 clean_session

Set to TRUE to instruct the broker to clean all messages and subscriptions on receving DISCONNECT, and FALSE to instruct it to keep them. When client_id is NULL, the value is ignored and the Clean Session flag in the CONNECT packet is set to 1.

Definition at line 196 of file m2mb_mqtt.h.

◆ client_id

char* client_id

A NULL-terminated string that is used as the client ID in the MQTT CONNECT packet. If NULL, a random 8-byte client ID is generated

Definition at line 194 of file m2mb_mqtt.h.

◆ keepalive_in_sec

unsigned short keepalive_in_sec

Keep Alive value in seconds. Setting this to 0 turns off the keep alive mechanism..

Definition at line 201 of file m2mb_mqtt.h.

◆ password

char* password

Password to send. Set to NULL when username is valid in order to send just a username

Definition at line 200 of file m2mb_mqtt.h.

◆ pSslCfg

void* pSslCfg

this contains the sslCfg Handle, user can verify m2mb_ssl.h file to configure SSL configuration

Definition at line 210 of file m2mb_mqtt.h.

◆ timeout_in_sec

unsigned short timeout_in_sec

After sending a connect packet to the broker, if the client does not receive a CONNACK packet from the broker within this time (in seconds), the client will close the network connection.

Definition at line 202 of file m2mb_mqtt.h.

◆ username

char* username

Username to send as a string, or NULL to disable authentication

Definition at line 199 of file m2mb_mqtt.h.

◆ will_msg

const char* will_msg

will message when will topic is not NULL.

Definition at line 206 of file m2mb_mqtt.h.

◆ will_qos

char will_qos

Integer value 0, 1, or 2, indicating the Quality of Service to be used for the will.

Definition at line 207 of file m2mb_mqtt.h.

◆ will_retain

char will_retain

Set to TRUE to make the will a retained message.

Definition at line 208 of file m2mb_mqtt.h.

◆ will_topic

const char* will_topic

Topic on which to publish the will, set to NULL if will is not to be used, will_msg, will_qos and will retain are then ignored

Definition at line 204 of file m2mb_mqtt.h.

The documentation for this struct was generated from the following file:

m2mb_mqtt.h

Data Fields