Класс QMqttSubscription
Класс QMqttSubscription получает уведомления от брокера MQTT о заданной теме. Подробнее...
| Заголовок: | #include <QMqttSubscription> |
| qmake: | QT += mqtt |
| Наследует: | QObject |
Типы публичного интерфейса
| Перечисление | SubscriptionState { Unsubscribed, SubscriptionPending, Subscribed, UnsubscriptionPending, Error } |
Свойства
|
|
Функции публичного интерфейса
| виртуальный | ~QMqttSubscription() override |
| bool | isSharedSubscription() const |
| quint8 | qos() const |
| QString | reason() const |
| QMqtt::ReasonCode | reasonCode() const |
| QString | sharedSubscriptionName() const |
| QMqttSubscription::SubscriptionState | state() const |
| QMqttTopicFilter | topic() const |
| QMqttUserProperties | userProperties() const |
Свойства слотов
| void | unsubscribe() |
Сигналы
| void | messageReceived(QMqttMessage msg) |
| void | qosChanged(quint8) |
| void | stateChanged(QMqttSubscription::SubscriptionState state) |
Подробное описание
Документация по типам членов
Перечисление QMqttSubscription::SubscriptionState
Это перечисление описывает состояния подписки.
| Константа | Значение | Описание |
|---|---|---|
QMqttSubscription::Unsubscribed |
0 |
Тема была отписана. |
QMqttSubscription::SubscriptionPending |
1 |
Запрос на подписку отправлен, но еще не подтвержден брокером. |
QMqttSubscription::Subscribed |
2 |
Подписка выполнена успешно, и сообщения будут получены. |
QMqttSubscription::UnsubscriptionPending |
3 |
Запрос на отписку отправлен, но еще не подтвержден брокером. |
QMqttSubscription::Error |
4 |
Произошла ошибка. |
Документация по свойствам
[read-only] qos : const quint8
Это свойство содержит уровень QoS, на котором была сделана подписка.
Уровень QoS подписки определяет максимальный уровень QoS, на котором клиент получит сообщения. Издатель все равно может отправлять сообщения на более низком уровне.
Функции доступа:
| quint8 | qos() const |
Сигнал уведомления:
| void | qosChanged(quint8) |
[read-only, since 5.12] reason : const QString
Это свойство содержит строку причины подписки.
Строка причины используется сервером для предоставления дополнительной информации о подписке. Сервер может ее и не отправлять.
Это свойство было добавлено в Qt 5.12.
Функции доступа:
| QString | reason() const |
[read-only, since 5.12] reasonCode : const QMqtt::ReasonCode
Это свойство содержит код причины подписки.
Код причины указывает тип ошибки, если подписка не удалась, или уровень QoS для успеха.
Это свойство было добавлено в Qt 5.12.
Функции доступа:
| QMqtt::ReasonCode | reasonCode() const |
[read-only, since 5.12] sharedSubscription : const bool
Это свойство содержит значение, указывающее, является ли подписка совместной.
Это свойство было добавлено в Qt 5.12.
Функции доступа:
| bool | isSharedSubscription() const |
[read-only, since 5.12] sharedSubscriptionName : const QString
Это свойство содержит имя совместной подписки.
Это свойство было добавлено в Qt 5.12.
Функции доступа:
| QString | sharedSubscriptionName() const |
[read-only] state : const SubscriptionState
Это свойство содержит состояние подписки.
Функции доступа:
| QMqttSubscription::SubscriptionState | state() const |
Сигнал уведомления:
| void | stateChanged(QMqttSubscription::SubscriptionState state) |
[read-only] topic : const QMqttTopicFilter
Это свойство содержит тему подписки.
Функции доступа:
| QMqttTopicFilter | topic() const |
Документация по функциям членов
[signal] void QMqttSubscription::messageReceived(QMqttMessage msg)
Этот сигнал генерируется при получении нового сообщения msg.
[slot] void QMqttSubscription::unsubscribe()
Отписывается от темы topic.
Примечание: Это может повлиять на все экземпляры общих указателей, возвращаемые QMqttClient::subscribe().
[override virtual] QMqttSubscription::~QMqttSubscription()
Удаляет подписку. Если от topic еще не было отписано, это произойдет автоматически.
END_OF_DOCUMENT_MARKER
[since 5.12] QMqttUserProperties QMqttSubscription::userProperties() const
Возвращает свойства пользователя, полученные от брокера при принятии подписки.
Примечание: Эта функция будет предоставлять действительные данные только в том случае, если клиент указывает QMqttClient::MQTT_5_0 в качестве QMqttClient::ProtocolVersion.
Эта функция была добавлена в Qt 5.12.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.1/qmqttsubscription.html
