Класс QMqttServerConnectionProperties
Класс QMqttServerConnectionProperties представляет параметры конфигурации сервера, к которому подключен клиент QMqttClient. Подробнее...
| Заголовок: | #include <QMqttServerConnectionProperties> |
| qmake: | QT += mqtt |
| С версии: | Qt 5.12 |
| Наследует: | QMqttConnectionProperties |
Открытые типы
| перечисление | ServerPropertyDetail { None, SessionExpiryInterval, MaximumReceive, MaximumQoS, RetainAvailable, …, AuthenticationData } |
| флаги | ServerPropertyDetails |
Открытые функции
| QMqttServerConnectionProperties::ServerPropertyDetails | availableProperties() const |
| bool | clientIdAssigned() const |
| bool | isValid() const |
| quint8 | maximumQoS() const |
| QString | reason() const |
| QMqtt::ReasonCode | reasonCode() const |
| QString | responseInformation() const |
| bool | retainAvailable() const |
| quint16 | serverKeepAlive() const |
| QString | serverReference() const |
| bool | sharedSubscriptionSupported() const |
| bool | subscriptionIdentifierSupported() const |
| bool | wildcardSupported() const |
Подробное описание
После установления соединения сервер может предоставить дополнительные сведения о свойствах соединения. Используйте availableProperties() для определения свойств, установленных сервером. Если свойство не задано сервером, предполагаются значения по умолчанию, которые можно получить, вызвав соответствующие методы этого экземпляра.
Примечание: Свойства соединения являются частью спецификации MQTT 5.0 и не могут быть использованы при подключении к серверу с более низким уровнем протокола. Для получения дополнительной информации см. QMqttClient::ProtocolVersion.
Документация по типам членов
перечисление QMqttServerConnectionProperties::ServerPropertyDetailфлаги QMqttServerConnectionProperties::ServerPropertyDetails
Этот тип перечисления определяет доступные свойства, установленные сервером или клиентом после установления соединения.
| Постоянная | Значение | Описание |
|---|---|---|
QMqttServerConnectionProperties::None |
0x00000000 |
Не задано ни одного свойства. |
QMqttServerConnectionProperties::SessionExpiryInterval |
0x00000001 |
Количество секунд, в течение которых сервер сохраняет сеанс после разъединения. |
QMqttServerConnectionProperties::MaximumReceive |
0x00000002 |
Максимальное количество сообщений QoS 1 и 2, которые сервер может обрабатывать одновременно. |
QMqttServerConnectionProperties::MaximumQoS |
0x00000004 |
Максимальный уровень QoS, поддерживаемый сервером. |
QMqttServerConnectionProperties::RetainAvailable |
0x00000010 |
Указывает, поддерживаются ли сохраненные сообщения. |
QMqttServerConnectionProperties::MaximumPacketSize |
0x00000020 |
Указывает максимальный размер пакета, включая заголовок сообщения и свойства. |
QMqttServerConnectionProperties::AssignedClientId |
0x00000040 |
Указывает, назначен ли клиенту идентификатор. |
QMqttServerConnectionProperties::MaximumTopicAlias |
0x00000080 |
Указывает максимальное количество псевдонимов тем. |
QMqttServerConnectionProperties::ReasonString |
0x00000100 |
Указывает строку с дополнительными сведениями о состоянии соединения. |
QMqttServerConnectionProperties::UserProperty |
0x00000200 |
Указывает дополнительные свойства пользователя. |
QMqttServerConnectionProperties::WildCardSupported |
0x00000400 |
Указывает, поддерживаются ли подписки с подстановкой шаблонов. |
QMqttServerConnectionProperties::SubscriptionIdentifierSupport |
0x00000800 |
Указывает, поддерживаются ли идентификаторы подписок. |
QMqttServerConnectionProperties::SharedSubscriptionSupport |
0x00001000 |
Указывает, поддерживаются ли совместные подписки. |
QMqttServerConnectionProperties::ServerKeepAlive |
0x00002000 |
Указывает количество секунд, которое сервер ожидает пакет keep alive от клиента. |
QMqttServerConnectionProperties::ResponseInformation |
0x00004000 |
Указывает информацию об ответе. |
QMqttServerConnectionProperties::ServerReference |
0x00008000 |
Указывает альтернатный адрес сервера для подключения клиента. |
QMqttServerConnectionProperties::AuthenticationMethod |
0x00010000 |
Указывает метод аутентификации. |
QMqttServerConnectionProperties::AuthenticationData |
0x00020000 |
Указывает данные аутентификации. |
Тип ServerPropertyDetails является псевдонимом для QFlags<ServerPropertyDetail>. Он хранит логическое ИЛИ комбинацию значений ServerPropertyDetail.
Документация по функциям-членам
QMqttServerConnectionProperties::ServerPropertyDetails QMqttServerConnectionProperties::availableProperties() const
Возвращает доступные свойства, указанные сервером.
bool QMqttServerConnectionProperties::clientIdAssigned() const
Возвращает true, если сервер назначил новый идентификатор клиента клиенту.
См. также QMqttClient::clientId().
bool QMqttServerConnectionProperties::isValid() const
Возвращает true, если сервер предоставил свойства в качестве части подтверждения соединения. Возвращает false, если свойства не были предоставлены.
quint8 QMqttServerConnectionProperties::maximumQoS() const
Возвращает максимальный уровень QoS, поддерживаемый сервером для публикации сообщений. Публикация сообщений с уровнем QoS, превышающим максимальный уровень QoS, указанный сервером, является нарушением протокола.
Если клиенту не нужно поддерживать QoS 1 или QoS 2, он должен ограничить максимальный уровень QoS в любой подписке значением, которое он может поддерживать; сервер затем опубликует сообщения с максимальным из поддерживаемого и ограниченного уровней QoS.
Значение по умолчанию — 2.
См. также QMqttClient::publish() и QMqttClient::subscribe().
QString QMqttServerConnectionProperties::reason() const
Возвращает строку причины, связанную с этим ответом.
QMqtt::ReasonCode QMqttServerConnectionProperties::reasonCode() const
Возвращает код причины, связанный с этим ответом.
QString QMqttServerConnectionProperties::responseInformation() const
Возвращает информацию о ответе.
bool QMqttServerConnectionProperties::retainAvailable() const
Возвращает true, если сервер принимает сохранённые сообщения. Значение по умолчанию — true.
quint16 QMqttServerConnectionProperties::serverKeepAlive() const
Возвращает количество секунд, запрошенное сервером как время ожидания. Это переопределяет время ожидания, заданное со стороны клиента.
См. также QMqttClient::setKeepAlive().
QString QMqttServerConnectionProperties::serverReference() const
Возвращает адрес сервера, который может быть использован клиентом для подключения альтернативно. Как правило, это используется вместе с кодом причины 0x9c (Использовать другой сервер) или 0x9c (Сервер перемещён).
bool QMqttServerConnectionProperties::sharedSubscriptionSupported() const
Возвращает true, если сервер принимает совместные подписки. Значение по умолчанию — true.
bool QMqttServerConnectionProperties::subscriptionIdentifierSupported() const
Возвращает true, если сервер принимает идентификаторы подписки. Идентификаторы подписки могут быть переданы серверу при создании новой подписки.
Значение по умолчанию — true.
См. также QMqttSubscriptionProperties::setSubscriptionIdentifier().
bool QMqttServerConnectionProperties::wildcardSupported() const
Возвращает true, если сервер принимает подписки, включающие подстановки. Значение по умолчанию — true.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qmqttserverconnectionproperties.html
