QMqttConnectionProperties Class

QMqttConnectionProperties 类表示QMqttClient 在调用QMqttClient::connectToHost() 时可传递给服务器的配置选项。更多

Header: #include <QMqttConnectionProperties>
CMake: find_package(Qt6 REQUIRED COMPONENTS Mqtt)
target_link_libraries(mytarget PRIVATE Qt6::Mqtt)
qmake: QT += mqtt
继承于

QMqttServerConnectionProperties

公共函数

QByteArray authenticationData() const
QString authenticationMethod() const
quint32 maximumPacketSize() const
quint16 maximumReceive() const
quint16 maximumTopicAlias() const
bool requestProblemInformation() const
bool requestResponseInformation() const
quint32 sessionExpiryInterval() const
void setAuthenticationData(const QByteArray &authData)
void setAuthenticationMethod(const QString &authMethod)
void setMaximumPacketSize(quint32 packetSize)
void setMaximumReceive(quint16 maximumReceive)
void setMaximumTopicAlias(quint16 alias)
void setRequestProblemInformation(bool problem)
void setRequestResponseInformation(bool response)
void setSessionExpiryInterval(quint32 expiry)
void setUserProperties(const QMqttUserProperties &properties)
QMqttUserProperties userProperties() const

详细说明

注意: 连接属性是 MQTT 5.0 规范的一部分,在使用较低协议级别连接时无法使用。更多信息请参阅QMqttClient::ProtocolVersion

成员函数文档

QByteArray QMqttConnectionProperties::authenticationData() const

返回身份验证数据。

另请参阅 setAuthenticationData()。

QString QMqttConnectionProperties::authenticationMethod() const

返回身份验证方法。

另请参阅 setAuthenticationMethod()。

quint32 QMqttConnectionProperties::maximumPacketSize() const

返回客户端可接收的最大数据包大小。

另请参阅 setMaximumPacketSize()。

quint16 QMqttConnectionProperties::maximumReceive() const

返回客户端(从QMqttClient::connectionProperties() 获取)或服务器(从QMqttClient::serverConnectionProperties() 获取)愿意同时处理此会话的 QoS 1 和 QoS 2 出版物的最大数量。

另请参阅 setMaximumReceive()。

quint16 QMqttConnectionProperties::maximumTopicAlias() const

返回客户端可使用的最大主题别名 ID。

另请参阅 setMaximumTopicAlias()。

bool QMqttConnectionProperties::requestProblemInformation() const

返回客户端是否应收到问题信息。

另请参阅 setRequestProblemInformation()。

bool QMqttConnectionProperties::requestResponseInformation() const

返回客户端是否应收到响应信息。

另请参阅 setRequestResponseInformation()。

quint32 QMqttConnectionProperties::sessionExpiryInterval() const

返回会话到期时间间隔。

另请参阅 setSessionExpiryInterval()。

void QMqttConnectionProperties::setAuthenticationData(const QByteArray &authData)

将身份验证数据设置为authData

只有指定了身份验证方法,才能使用身份验证数据。

另请参阅 authenticationData() 和authenticationMethod()。

void QMqttConnectionProperties::setAuthenticationMethod(const QString &authMethod)

将身份验证方法设置为authMethod

另请参阅 authenticationMethod() 和authenticationData()。

void QMqttConnectionProperties::setMaximumPacketSize(quint32 packetSize)

将最大数据包大小设置为packetSize 。最大数据包大小指定了一个数据包所能包含的最大大小。这包括数据包标头及其属性。

如果未指定最大数据包大小,则除了协议本身的限制外,不会有其他限制。

另请参阅 maximumPacketSize() 。

void QMqttConnectionProperties::setMaximumReceive(quint16 maximumReceive)

将客户端愿意同时处理此会话的 QoS 1 和 QoS 2 出版物的最大数量设置为maximumReceive

不允许最大接收值为 0。

另请参阅 maximumReceive() 。

void QMqttConnectionProperties::setMaximumTopicAlias(quint16 alias)

将最大主题别名设置为alias 。最大主题别名指定了客户端从服务器接受的最高值。客户端使用该值来限制它愿意为连接保留的主题别名数量。

默认值为 0。0 表示客户端不接受此连接上的任何主题别名。

另请参阅 maximumTopicAlias()。

void QMqttConnectionProperties::setRequestProblemInformation(bool problem)

将请求问题信息设置为problem 。客户端使用该信息请求服务器在出现故障时返回附加信息。故障类型包括服务器端的连接和信息管理。

默认值为false ,表示客户端除了连接管理外,不得接收任何问题信息。服务器仍可发送用于连接处理的问题信息。如果值为true ,服务器可返回问题信息。

问题信息可在用户属性或属性类的原因字符串中找到。

另请参阅 requestProblemInformation()。

void QMqttConnectionProperties::setRequestResponseInformation(bool response)

将请求响应信息设置为response 。客户端使用它来请求服务器在处理完连接请求后返回响应信息。

默认值为false ,表示客户端不得返回任何响应信息。如果值为true ,服务器可以返回响应信息,但不强制这样做。

另请参阅 requestResponseInformation() 。

void QMqttConnectionProperties::setSessionExpiryInterval(quint32 expiry)

将会话过期时间间隔设置为expiry 。会话过期时间间隔指定服务器在连接关闭后保留客户端状态信息的秒数。

默认值为 0,表示会话在网络连接结束时关闭。如果该值指定为 quint32 的最大值,则会话不会过期。

另请参阅 sessionExpiryInterval().

void QMqttConnectionProperties::setUserProperties(const QMqttUserProperties &properties)

将连接的用户属性设置为properties

默认值是不发送任何用户信息。

另请参阅 userProperties() 。

QMqttUserProperties QMqttConnectionProperties::userProperties() const

返回连接的用户属性。

另请参阅 setUserProperties()。

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.