Класс QMqttConnectionProperties

Класс QMqttConnectionProperties представляет параметры конфигурации, которые QMqttClient может передать серверу при вызове QMqttClient::connectToHost(). Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

Подробное описание

Примечание: Свойства подключения являются частью спецификации MQTT 5.0 и не могут быть использованы при подключении с более низким уровнем протокола. Подробнее см. QMqttClient::ProtocolVersion.

Документация по функциям-членам

QByteArray QMqttConnectionProperties::authenticationData() const

Возвращает данные аутентификации.

См. также setAuthenticationData().

QString QMqttConnectionProperties::authenticationMethod() const

Возвращает метод аутентификации.

См. также setAuthenticationMethod().

quint32 QMqttConnectionProperties::maximumPacketSize() const

Возвращает максимальный размер пакета, который может получить клиент.

См. также setMaximumPacketSize().

quint16 QMqttConnectionProperties::maximumReceive() const

Возвращает максимальное количество публикаций QoS 1 и QoS 2, которые клиент (полученный из QMqttClient::connectionProperties()) или сервер (полученный из QMqttClient::serverConnectionProperties()) готов обработать одновременно для этой сессии.

См. также setMaximumReceive().

quint16 QMqttConnectionProperties::maximumTopicAlias() const

Возвращает максимальный идентификатор псевдонима темы, который может использовать клиент.

См. также 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().