Класс 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 еще не было отписано, она будет отписана автоматически.
[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.2/qmqttsubscription.html
