QMqttConnectionProperties 类
QMqttConnectionProperties 类表示一个 QMqttClient 可以在调用 QMqttClient::connectToHost() 时传递给服务器的配置选项。 更多...
头文件 | #include <QMqttConnectionProperties> |
CMake | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
qmake | QT += mqtt |
继承自 |
公开函数
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。最大数据包大小指定了一个数据包可以包含的最大大小。这包括数据包头和它的属性。
如果没有指定最大包大小,则不会对协议本身之外的限制施加限制。
另请参阅 最大包大小()。
void QMqttConnectionProperties::setMaximumReceive(quint16 maximumReceive)
将客户端在该会话中对 QoS 1 和 QoS 2 发布 willing to process concurrently 的最大数量设置为 maximumReceive。
不允许最大接收值为 0。
另请参阅 最大接收()。
void QMqttConnectionProperties::setMaximumTopicAlias(quint16 alias)
将最大主题别名设置为 alias。最大主题别名指定客户端从服务器接受的最高值。客户端使用此值来限制它愿意为连接保存的主题别名数。
默认值是 0。0 表示客户端不在此连接上接受任何主题别名。
另请参阅 最大主题别名()。
void QMqttConnectionProperties::setRequestProblemInformation(bool problem)
将请求问题信息设置为 problem。客户端使用此功能请求服务器在出现失败时返回附加信息。失败类型包括服务器的连接和消息管理。
默认值是 false
,表示客户端除非是连接管理,否则不允许接收任何问题信息。服务器仍可以发送连接处理的问题信息。如果值为 true
,则服务器可以返回问题信息。
问题信息可用在用户属性或属性类的错误信息字符串中。
另请参阅 请求问题信息()。
void QMqttConnectionProperties::setRequestResponseInformation(bool response)
将请求响应信息设置为 response。客户端使用此功能请求服务器在处理连接请求后返回响应信息。
默认值是 false
,表示客户端不允许返回任何响应信息。如果值为 true
,则服务器可以返回响应信息,但不是强制要求这样做。
另请参阅 请求响应信息()。
void QMqttConnectionProperties::setSessionExpiryInterval(quint32 expiry)
将会话有效期设置为 expiry。会话有效期指定服务器在连接关闭后保留客户端状态信息的时间(秒)。
默认值是 0,表示在网络连接结束时关闭会话。如果指定值是 quint32 的最大值,则会话不会过期。
另请参阅 会话有效期()。
void QMqttConnectionProperties::setUserProperties(const QMqttUserProperties &properties)
将连接的用户属性设置为 properties。
默认值是不发送任何用户信息。
另请参阅 userProperties。
QMqttUserProperties QMqttConnectionProperties::userProperties() const
返回连接的用户属性。
另请参阅 setUserProperties。
© 2024 The Qt Company Ltd. 本文档中的文档贡献均为其各自所有者的版权。所提供的文档是根据自由软件基金会发布并由其赞助的GNU自由文档许可证第1.3版的条款许可的。Qt及其各自的标志是芬兰以及世界其他地区的The Qt Company Ltd的商标。所有其他商标均为其各自所有者的财产。