Класс QMqttPublishProperties

Класс QMqttPublishProperties представляет параметры конфигурации для отправки или получения сообщения. Подробнее...

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

Общие типы

Общие функции

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

Вызов QMqttClient::publish() для отправки сообщения на брокер может включать QMqttPublishProperties для предоставления дополнительных аргументов о том, как сообщение должно обрабатываться на броке.

Кроме того, получение сообщения подписчиком может содержать свойства публикации, которые были перенаправлены или адаптированы сервером.

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

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

перечисление QMqttPublishProperties::PublishPropertyDetailфлаги QMqttPublishProperties::PublishPropertyDetails

Этот тип перечисления определяет доступные свойства, заданные сервером или клиентом при создании сообщения.

Тип PublishPropertyDetails является типом-синонимом для QFlags<PublishPropertyDetail>. Он хранит логическое ИЛИ сочетание значений PublishPropertyDetail.

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

QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const

Возвращает доступные свойства, указанные в данном экземпляре. При создании сообщения не требуется включать все свойства. Эта функция служит показателем тех свойств, которые были явно установлены.

QString QMqttPublishProperties::contentType() const

Возвращает тип содержимого сообщения.

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

QByteArray QMqttPublishProperties::correlationData() const

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

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

quint32 QMqttPublishProperties::messageExpiryInterval() const

Возвращает интервал истечения срока действия сообщения. Это значение задаёт количество секунд, которое серверу разрешается пересылать сообщение. Если интервал истечёт, сервер должен удалить сообщение и прервать публикацию.

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

QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const

Возвращает индикатор формата полезной нагрузки.

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

QString QMqttPublishProperties::responseTopic() const

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

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

void QMqttPublishProperties::setContentType(const QString &type)

Устанавливает тип содержимого сообщения на type.

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

void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)

Устанавливает корреляционные данные на correlation.

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

void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)

Устанавливает интервал истечения срока действия сообщения на interval.

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

void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)

Устанавливает индикатор формата полезной нагрузки на indicator.

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

void QMqttPublishProperties::setResponseTopic(const QString &topic)

Устанавливает ответный топик на topic.

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

void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)

Устанавливает идентификаторы подписок на ids.

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

void QMqttPublishProperties::setTopicAlias(quint16 alias)

Устанавливает псевдоним топика для публикации сообщения на alias. Значение псевдонима топика должно быть больше нуля и меньше максимального значения псевдонима топика, указанного сервером.

См. также topicAlias() и QMqttServerConnectionProperties::maximumTopicAlias().

void QMqttPublishProperties::setUserProperties(const QMqttUserProperties &properties)

Устанавливает пользовательские свойства сообщения на properties.

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

QList<quint32> QMqttPublishProperties::subscriptionIdentifiers() const

Возвращает идентификаторы подписок, соответствующие фильтру топика сообщения.

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

quint16 QMqttPublishProperties::topicAlias() const

Возвращает псевдоним топика, используемый для публикации сообщения.

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

QMqttUserProperties QMqttPublishProperties::userProperties() const

Возвращает пользовательские свойства сообщения.

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