class QMqttPublishProperties#

QMqttPublishProperties类代表了发送或接收消息的配置选项。 更多...

概述#

方法#

注意

此文档可能包含自动从C++转换为Python的代码片段。我们总是欢迎对片段翻译的贡献。如果您发现翻译中的问题，您也可以通过在https:/bugreports.qt.io/projects/PYSIDE创建一个票据来让我们知道。

详细描述#

调用publish()发送消息到代理可以包括QMqttPublishProperties来提供关于如何在代理处处理消息的附加参数。

此外，由已实例化的订阅接收到的消息可能包含经过服务器转发或修改的发布属性。

注意

发布属性是MQTT 5.0规范的一部分，在低协议级别连接时无法使用。有关更多信息，请参阅ProtocolVersion。

class PublishPropertyDetail#

(继承自 enum.Flag) 此枚举类型指定在创建消息时由服务器或客户端设置的可用属性集。

常量

说明

QMqttPublishProperties.None

未指定任何属性。

QMqttPublishProperties.PayloadFormatIndicator

消息内容的类型。

QMqttPublishProperties.MessageExpiryInterval

消息有效的时间长度。

QMqttPublishProperties.TopicAlias

此消息的主题别名。

QMqttPublishProperties.ResponseTopic

收件人需要响应的主题。

QMqttPublishProperties.CorrelationData

响应消息的标识符。

QMqttPublishProperties.UserProperty

用户设置的附加属性。

QMqttPublishProperties.SubscriptionIdentifier

匹配发布的订阅标识符。

QMqttPublishProperties.ContentType

消息内容的描述。
__init__(arg__1)#
参数:

arg__1 – QMqttPublishProperties

__init__()
availableProperties()#
返回类型:

PySide6.QtMqtt.QMqttPublishProperties.PublishPropertyDetail 的组合

返回此实例中指定的可用属性。在创建消息时，不需要包含所有属性。此函数用作已显式设置的属性的指示器。

contentType()#
返回类型:

str

返回消息的内容类型。

correlationData()#
返回类型:

QByteArray

返回关联数据。

messageExpiryInterval()#
返回类型:

int

返回消息过期间隔。此值指定服务器允许转发消息的秒数。如果间隔到期，则服务器必须删除消息并终止发布。

payloadFormatIndicator()#
返回类型:

PayloadFormatIndicator

返回负载格式指示符。

responseTopic()#
返回类型:

str

返回用户应作为请求后续操作使用的响应主题。

setContentType(type)#
参数:

type – str

将消息内容类型设置为 type。

参见

contentType()

setCorrelationData(correlation)#
参数:

相关性 – QByteArray

将相关性数据设置为 correlation。

setMessageExpiryInterval(interval)#
参数:

interval – int

将消息过期时间设置为 interval。

setPayloadFormatIndicator(indicator)#
参数:

indicator – PayloadFormatIndicator

将有效载荷格式指示器设置为 indicator。

setResponseTopic(topic)#
参数:

topic – str

将响应主题设置为 topic。

setSubscriptionIdentifiers(ids)#
参数:

ids – .quint32 列表

将订阅标识符设置为 ids。

setTopicAlias(alias)#
参数:

alias – int

为发送消息设置主题别名 alias。主题别名值必须大于零且小于服务器指定的最大主题别名。

参见

topicAlias() maximumTopicAlias()

setUserProperties(properties)#
参数:

properties – QMqttUserProperties

将消息的用户属性设置为 properties。

subscriptionIdentifiers()#
返回类型:

.quint32 列表

返回与消息主题过滤器匹配的订阅的订阅标识符。

topicAlias()#
返回类型:

int

返回用于发布消息的主题别名。

userProperties()#
返回类型:

QMqttUserProperties

返回消息的用户属性。