class QMqttServerConnectionProperties

QMqttServerConnectionProperties 类表示 QMqttClient 连接到服务器的配置选项。 更多信息...

摘要

方法

• def __init__()

• def availableProperties()

• def clientIdAssigned()

• 定义 isValid()

• 定义 maximumQoS()

• 定义 reason()

• 定义 reasonCode()

• 定义 responseInformation()

• 定义 retainAvailable()

• 定义 serverKeepAlive()

• 定义 serverReference()

• 定义 sharedSubscriptionSupported()

• 定义 subscriptionIdentifierSupported()

• 定义 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)

参数:

arg__1 – QMqttServerConnectionProperties

availableProperties()

返回类型:

由 ServerPropertyDetail 组成的组合

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

clientIdAssigned()

返回类型:

bool

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

另请参阅

clientId()

isValid()

返回类型:

bool

如果服务器作为连接确认的一部分提供了属性，返回 true；如果没有提供属性，返回 false。

maximumQoS()

返回类型:

int

返回服务器支持发布的最大QoS级别。发布大于由服务器报告的最大QoS级别消息是协议违规。

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

默认值是 2。

另请参阅

publish() subscribe()

reason()

返回类型:

字符串

返回与此响应相关的理由字符串。

reasonCode()

返回类型:

原因代码

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

responseInformation()

返回类型:

字符串

返回响应信息。

retainAvailable()

返回类型:

bool

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

serverKeepAlive()

返回类型:

int

返回服务器要求的保活时间的秒数。这将覆盖从客户端设置的保活。

另请参阅

setKeepAlive()

serverReference()

返回类型:

字符串

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

sharedSubscriptionSupported()

返回类型:

bool

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

subscriptionIdentifierSupported()

返回类型:

bool

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

默认值是 true。

另请参阅

setSubscriptionIdentifier()

wildcardSupported()

返回类型:

bool

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