PySide6.QtMqtt.QMqttServerConnectionProperties¶

class QMqttServerConnectionProperties¶

QMqttServerConnectionProperties 类表示 QMqttClient 所连接的服务器配置选项。更多…

概要¶

方法¶

• def __init__()

• def availableProperties()

• def clientIdAssigned()

• def isValid()

• def maximumQoS()

• def reason()

• def reasonCode()

• def responseInformation()

• def retainAvailable()

• def serverKeepAlive()

• def serverReference()

• def sharedSubscriptionSupported()

• def subscriptionIdentifierSupported()

• def wildcardSupported()

注意

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

详细描述¶

当连接建立后，服务器可能会发送有关连接属性的额外详细信息。使用availableProperties()来识别由服务器设置的属性。如果服务器未设置某个属性，则假定为默认值，并可以通过调用此实例的访问函数来获取。

注意

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

class ServerPropertyDetail¶

(继承自 enum.Flag) 此枚举类型指定了在建立连接后由服务器或客户端设置的可用属性。

常量	描述
QMqttServerConnectionProperties.None	未指定任何属性。
QMqttServerConnectionProperties.SessionExpiryInterval	服务器在断开连接后保持会话的秒数。
QMqttServerConnectionProperties.MaximumReceive	服务器能够同时管理的QoS 1和2消息的最大数量。
QMqttServerConnectionProperties.MaximumQoS	服务器能够理解的最大QoS级别。
QMqttServerConnectionProperties.RetainAvailable	指定是否支持保留消息。
QMqttServerConnectionProperties.MaximumPacketSize	指定包括消息头和属性在内的最大数据包大小。
QMqttServerConnectionProperties.AssignedClientId	指定服务器是否分配了客户端标识符。
QMqttServerConnectionProperties.MaximumTopicAlias	指定主题别名的最大数量。
QMqttServerConnectionProperties.ReasonString	指定一个字符串，提供有关连接状态的更多详细信息。
QMqttServerConnectionProperties.UserProperty	指定额外的用户属性。
QMqttServerConnectionProperties.WildCardSupported	指定服务器是否支持通配符订阅。
QMqttServerConnectionProperties.SubscriptionIdentifierSupport	指定服务器是否支持订阅标识符。
QMqttServerConnectionProperties.SharedSubscriptionSupport	指定服务器是否支持共享订阅。
QMqttServerConnectionProperties.ServerKeepAlive	指定服务器期望从客户端接收到保持活动数据包的秒数。
QMqttServerConnectionProperties.ResponseInformation	指定响应信息。
QMqttServerConnectionProperties.ServerReference	指定客户端连接的备用服务器地址。
QMqttServerConnectionProperties.AuthenticationMethod	指定认证方法。
QMqttServerConnectionProperties.AuthenticationData	指定认证数据。

__init__()¶

__init__(arg__1)

Parameters:

arg__1 – QMqttServerConnectionProperties

availableProperties()¶

Return type:

ServerPropertyDetail 的组合

返回服务器指定的可用属性。

clientIdAssigned()¶

Return type:

布尔

如果服务器为客户端分配了新的客户端标识符，则返回 true。

另请参阅

clientId()

isValid()¶

Return type:

布尔

如果服务器在连接确认时提供了属性，则返回true。如果没有提供属性，则返回false。

maximumQoS()¶

Return type:

整数

返回服务器支持发布消息的最大QoS级别。发布消息时使用超过服务器报告的最大QoS级别是违反协议的。

如果客户端不需要支持QoS 1或QoS 2，它应该限制其任何订阅中的最大QoS级别为其可以支持的值；然后服务器将以支持和限制的QoS级别中的最大值发布消息。

默认值为2。

另请参阅

publish() subscribe()

reason()¶

Return type:

字符串

返回与此响应相关的原因字符串。

reasonCode()¶

Return type:

ReasonCode

返回与此响应相关的原因代码。

responseInformation()¶

Return type:

字符串

返回响应信息。

retainAvailable()¶

Return type:

布尔

如果服务器接受保留消息，则返回true。默认值为true。

serverKeepAlive()¶

Return type:

整数

返回服务器请求的保持连接秒数。这将覆盖客户端设置的保持连接时间。

另请参阅

setKeepAlive()

serverReference()¶

Return type:

字符串

返回一个服务器地址，客户端可以使用该地址作为替代连接。通常，这与原因代码 0x9c（使用另一个服务器）或 0x9c（服务器已移动）一起使用。

sharedSubscriptionSupported()¶

Return type:

布尔

如果服务器接受共享订阅，则返回true。默认值为true。

subscriptionIdentifierSupported()¶

Return type:

布尔

如果服务器接受订阅标识符，则返回true。在创建新订阅时，可以将订阅标识符传递给服务器。

默认值为 true。

另请参阅

setSubscriptionIdentifier()

wildcardSupported()¶

Return type:

布尔

如果服务器接受包含通配符的订阅，则返回true。默认值为true。