PySide6.QtMqtt.QMqttMessage

class QMqttMessage

QMqttMessage 类提供了关于从消息代理接收到的消息的信息,该消息基于订阅。更多

概要

属性

  • duplicateᅟ - 此属性表示消息是否为重复消息

  • idᅟ - 此属性保存消息的ID

  • payloadᅟ - 此属性保存消息的有效载荷

  • qosᅟ - 此属性保存消息的QoS级别

  • retainᅟ - 此属性表示消息是否已被保留

  • topicᅟ - 此属性保存消息的主题

方法

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题,您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述

MQTT消息在模块内部创建,并通过messageReceived()信号返回。

注意

当使用from __feature__ import true_property时,属性可以直接使用,否则通过访问器函数使用。

property duplicateᅟ: bool

此属性表示此属性表示消息是否为重复消息。

重复消息表示该消息之前已经发送过,但尚未得到确认。因此,代理认为需要重新发送以验证消息本身的传输。只有在QoS级别为1或2时,才会出现重复消息。

Access functions:
property idᅟ: int

此属性保存消息的ID。

ID用于QoS级别大于零的消息。

Access functions:
property payloadᅟ: QByteArray

此属性保存消息的有效负载。

Access functions:
property qosᅟ: int

此属性保存消息的QoS级别。

Access functions:
property retainᅟ: bool

此属性表示消息是否已被保留。

保留消息被保存在代理上,以便未来的客户端订阅。因此,保留消息是之前创建的,而不是实时更新。代理每个主题只能存储一条保留消息。

Access functions:
property topicᅟ: QMqttTopicName

此属性保存消息的主题。

如果订阅使用了通配符,描述与此订阅匹配的主题。此属性从不包含通配符。

Access functions:
__init__()

创建一个新的MQTT消息。

__init__(other)
Parameters:

其他QMqttMessage

构造一个新的MQTT消息,它是other的副本。

duplicate()
Return type:

布尔

属性 duplicateᅟ 的获取器。

id()
Return type:

整数

属性 idᅟ 的获取器。

__eq__(other)
Parameters:

其他QMqttMessage

Return type:

布尔

如果消息和other相等,则返回true,否则返回false

payload()
Return type:

QByteArray

属性 payloadᅟ 的获取器。

publishProperties()
Return type:

QMqttPublishProperties

返回作为消息一部分接收的发布属性。

注意

此函数仅在接收到发布消息时指定属性。当消息被释放时,具有QoS值为1或2的消息可能包含额外的属性。这些属性可以通过messageStatusChanged信号获取。

注意

此函数仅在客户端指定MQTT_5_0作为ProtocolVersion时提供有效数据。

qos()
Return type:

整数

属性 qosᅟ 的获取器。

retain()
Return type:

布尔

属性 retainᅟ 的获取器。

topic()
Return type:

QMqttTopicName

属性 topicᅟ 的获取器。