PySide6.QtMqtt.QMqttConnectionProperties

class QMqttConnectionProperties

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

继承者: QMqttServerConnectionProperties

概要

方法

注意

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

详细描述

注意

连接属性是MQTT 5.0规范的一部分,当使用较低协议级别连接时无法使用。有关更多信息,请参见ProtocolVersion

__init__()
__init__(arg__1)
Parameters:

arg__1QMqttConnectionProperties

authenticationData()
Return type:

QByteArray

返回认证数据。

authenticationMethod()
Return type:

字符串

返回认证方法。

maximumPacketSize()
Return type:

整数

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

另请参阅

setMaximumPacketSize()

maximumReceive()
Return type:

整数

返回客户端(当从connectionProperties()获取时)或服务器(当从serverConnectionProperties()获取时)愿意为此会话同时处理的QoS 1和QoS 2发布的最大数量。

另请参阅

setMaximumReceive()

maximumTopicAlias()
Return type:

整数

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

另请参阅

setMaximumTopicAlias()

requestProblemInformation()
Return type:

布尔

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

requestResponseInformation()
Return type:

布尔

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

sessionExpiryInterval()
Return type:

整数

返回会话过期时间间隔。

setAuthenticationData(authData)
Parameters:

authDataQByteArray

将认证数据设置为 authData

只有在指定了认证方法的情况下,才能使用认证数据。

setAuthenticationMethod(authMethod)
Parameters:

authMethod – str

将认证方法设置为 authMethod

setMaximumPacketSize(packetSize)
Parameters:

packetSize – int

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

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

另请参阅

maximumPacketSize()

setMaximumReceive(maximumReceive)
Parameters:

maximumReceive – int

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

不允许最大接收值为0。

另请参阅

maximumReceive()

setMaximumTopicAlias(alias)
Parameters:

alias – 整数

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

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

另请参阅

maximumTopicAlias()

setRequestProblemInformation(problem)
Parameters:

问题 – 布尔值

将请求问题信息设置为problem。客户端使用此功能请求服务器在失败时返回附加信息。失败类型包括服务器端的连接和消息管理。

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

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

setRequestResponseInformation(response)
Parameters:

response – 布尔值

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

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

setSessionExpiryInterval(expiry)
Parameters:

expiry – int

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

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

setUserProperties(properties)
Parameters:

属性QMqttUserProperties

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

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

另请参阅

userProperties()

userProperties()
Return type:

QMqttUserProperties

返回连接的用户属性。

另请参阅

setUserProperties()