QMqttPublishProperties 类
QMqttPublishProperties 类表示发送或接收消息的配置选项。 更多...
| 头文件 | #include <QMqttPublishProperties> |
| CMake | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake | QT += mqtt |
公共类型
| 枚举 | PublishPropertyDetail { None, PayloadFormatIndicator, MessageExpiryInterval, TopicAlias, ResponseTopic, …, ContentType } |
| 标志 | PublishPropertyDetails |
公共函数
| QMqttPublishProperties::PublishPropertyDetails | availableProperties() const |
| QString | contentType() const |
| QByteArray | correlationData() const |
| quint32 | messageExpiryInterval() const |
| QMqtt::PayloadFormatIndicator | payloadFormatIndicator() const |
| QString | responseTopic() const |
| void | setContentType(const QString &type) |
| void | setCorrelationData(const QByteArray &correlation) |
| void | setMessageExpiryInterval(quint32 interval) |
| void | setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator) |
| void | setResponseTopic(const QString &topic) |
| void | setSubscriptionIdentifiers(const QList<quint32> &ids) |
| void | setTopicAlias(quint16 alias) |
| void | setUserProperties(const QMqttUserProperties &properties) |
| QList<quint32> | subscriptionIdentifiers() const |
| quint16 | topicAlias() const |
| QMqttUserProperties | userProperties() const |
详细描述
调用 QMqttClient::publish() 向代理发送消息时，可以包括 QMqttPublishProperties 来提供如何在代理上处理消息的额外参数。
此外，使用实例化的订阅接收消息可能包含已被服务器转发或修改的发布属性。
注意：发布属性是 MQTT 5.0 规范的一部分，无法在连接到较低协议级别时使用。有关更多信息，请参阅 QMqttClient::ProtocolVersion。
成员类型文档
枚举 QMqttPublishProperties::PublishPropertyDetail
标志 QMqttPublishProperties::PublishPropertyDetails
此枚举类型指定了在创建消息时服务器或客户端可用的属性集。
| 常量 | 值 | 描述 |
|---|---|---|
QMqttPublishProperties::None | 0x00000000 | 未指定任何属性。 |
QMqttPublishProperties::PayloadFormatIndicator | 0x00000001 | 消息内容类型。 |
QMqttPublishProperties::MessageExpiryInterval | 0x00000002 | 消息的有效期。 |
QMqttPublishProperties::TopicAlias | 0x00000004 | 此消息的主题别名。 |
QMqttPublishProperties::ResponseTopic | 0x00000008 | 接收者应响应的主题。 |
QMqttPublishProperties::CorrelationData | 0x00000010 | 响应消息的标识符。 |
QMqttPublishProperties::UserProperty | 0x00000020 | 用户设置的附加属性。 |
QMqttPublishProperties::SubscriptionIdentifier | 0x00000040 | 与发布匹配的订阅标识符。 |
QMqttPublishProperties::ContentType | 0x00000080 | 消息内容的描述。 |
PublishPropertyDetails 类型是 QFlags<PublishPropertyDetail> 的 typedef。它存储了 PublishPropertyDetail 值的 OR 组合。
成员函数文档
QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const
返回此实例中指定的可用属性。创建消息时，不需要包含所有属性。此函数作为已显式设置的属性指示器。
QString QMqttPublishProperties::contentType() const
返回消息的内容类型。
另请参阅 setContentType().
QByteArray QMqttPublishProperties::correlationData() const
返回关联数据。
另请参阅 setCorrelationData().
quint32 QMqttPublishProperties::messageExpiryInterval() const
返回消息有效期。此值指定服务器允许转发消息的秒数。如果间隔过期，服务器必须删除消息并终止发布。
另请参阅 setMessageExpiryInterval().
QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const
返回有效载荷格式指示符。
另请参阅 setPayloadFormatIndicator().
QString QMqttPublishProperties::responseTopic() const
返回用户在请求后续操作时应使用的响应主题。
另请参阅 setResponseTopic().
void QMqttPublishProperties::setContentType(const QString &type)
将消息的内容类型设置为 type。
另请参阅 contentType().
void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)
设置关联数据到 correlation。
另请参阅correlationData()。
void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)
设置消息过期间隔为 interval。
另请参阅messageExpiryInterval()。
void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)
设置负载格式指示器为 indicator。
另请参阅payloadFormatIndicator()。
void QMqttPublishProperties::setResponseTopic(const QString &topic)
设置响应主题为 topic。
另请参阅responseTopic()。
void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)
设置订阅标识符为 ids。
另请参阅subscriptionIdentifiers()。
void QMqttPublishProperties::setTopicAlias(quint16 alias)
设置发布消息的订阅主题别名为 alias。主题别名值必须大于零，小于服务器指定的最大主题别名。
另请参阅topicAlias() 和 QMqttServerConnectionProperties::maximumTopicAlias()。
void QMqttPublishProperties::setUserProperties(const QMqttUserProperties &properties)
设置消息的用户属性为 properties。
另请参阅userProperties()。
QList<quint32> QMqttPublishProperties::subscriptionIdentifiers() const
返回与消息主题筛选器匹配的订阅的标识符。
另请参阅setSubscriptionIdentifiers()。
quint16 QMqttPublishProperties::topicAlias() const
返回用于发布消息的主题别名。
另请参阅setTopicAlias()。
QMqttUserProperties QMqttPublishProperties::userProperties() const
返回消息的用户属性。
另请参阅setUserProperties()。
© 2024 The Qt Company Ltd。本文件中包含的文档贡献归各自的拥有者所有。本文件提供的文档在由Free Software Foundation发布的前提下，根据GNU自由文档许可1.3版的条款进行许可。Qt及其相关标志是芬兰及/或世界其他国家的The Qt Company Ltd.的商标。商标的所有权属于各自的拥有者。
