#include <MQTTClient.h>

MQTTClient_message 的协作图:

Public 属性
char	struct_id [4]

int	struct_version

int	payloadlen

void *	payload

int	qos

int	retained

int	dup

int	msgid

MQTTProperties	properties

详细描述

A structure representing the payload and attributes of an MQTT message. The message topic is not part of this structure (see MQTTClient_publishMessage(), MQTTClient_publish(), MQTTClient_receive(), MQTTClient_freeMessage() and MQTTClient_messageArrived()).

在文件 MQTTClient.h 第 267 行定义.

类成员变量说明

int MQTTClient_message::dup

The dup flag indicates whether or not this message is a duplicate. It is only meaningful when receiving QoS1 messages. When true, the client application should take appropriate action to deal with the duplicate message.

在文件 MQTTClient.h 第 317 行定义.

int MQTTClient_message::msgid

The message identifier is normally reserved for internal use by the MQTT client and server.

在文件 MQTTClient.h 第 321 行定义.

void* MQTTClient_message::payload

A pointer to the payload of the MQTT message.

在文件 MQTTClient.h 第 277 行定义.

int MQTTClient_message::payloadlen

The length of the MQTT message payload in bytes.

在文件 MQTTClient.h 第 275 行定义.

MQTTProperties MQTTClient_message::properties

The MQTT V5 properties associated with the message.

在文件 MQTTClient.h 第 325 行定义.

int MQTTClient_message::qos

The quality of service (QoS) assigned to the message. There are three levels of QoS:

QoS0: Fire and forget - the message may not be delivered
QoS1: At least once - the message will be delivered, but may be delivered more than once in some circumstances.
QoS2: Once and one only - the message will be delivered exactly once.

在文件 MQTTClient.h 第 291 行定义.

int MQTTClient_message::retained

The retained flag serves two purposes depending on whether the message it is associated with is being published or received.

retained = true
For messages being published, a true setting indicates that the MQTT server should retain a copy of the message. The message will then be transmitted to new subscribers to a topic that matches the message topic. For subscribers registering a new subscription, the flag being true indicates that the received message is not a new one, but one that has been retained by the MQTT server.

retained = false
For publishers, this indicates that this message should not be retained by the MQTT server. For subscribers, a false setting indicates this is a normal message, received as a result of it being published to the server.

在文件 MQTTClient.h 第 310 行定义.

char MQTTClient_message::struct_id[4]

The eyecatcher for this structure. must be MQTM.

在文件 MQTTClient.h 第 270 行定义.

int MQTTClient_message::struct_version

The version number of this structure. Must be 0 or 1 0 indicates no message properties

在文件 MQTTClient.h 第 273 行定义.

该结构体的文档由以下文件生成:

tqinclude/paho_mqtt_c/MQTTClient.h

Public 属性

详细描述

类成员变量说明