QMqttConnectionProperties Class

成员函数文档

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()。