QMqttSubscription Class
Die Klasse QMqttSubscription empfängt Benachrichtigungen von einem MQTT-Broker über ein bestimmtes Thema. Mehr...
| Kopfzeile: | #include <QMqttSubscription> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt)target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
| Vererbungen: | QObject |
Öffentliche Typen
| enum | SubscriptionState { Unsubscribed, SubscriptionPending, Subscribed, UnsubscriptionPending, Error } |
Eigenschaften
|
|
Öffentliche Funktionen
| virtual | ~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 |
Öffentliche Slots
| void | unsubscribe() |
Signale
| void | messageReceived(QMqttMessage msg) |
| void | qosChanged(quint8) |
| void | stateChanged(QMqttSubscription::SubscriptionState state) |
Dokumentation der Mitgliedstypen
enum QMqttSubscription::SubscriptionState
Dieser Enum-Typ beschreibt die Zustände, die ein Abonnement haben kann.
| Konstante | Wert | Beschreibung |
|---|---|---|
QMqttSubscription::Unsubscribed | 0 | Das Thema wurde abgemeldet. |
QMqttSubscription::SubscriptionPending | 1 | Es wurde eine Anfrage für ein Abonnement gesendet, aber noch nicht vom Broker bestätigt. |
QMqttSubscription::Subscribed | 2 | Das Abonnement war erfolgreich und es werden Nachrichten empfangen. |
QMqttSubscription::UnsubscriptionPending | 3 | Es wurde eine Anfrage zur Abmeldung von einem Thema gesendet, die jedoch noch nicht vom Broker bestätigt wurde. |
QMqttSubscription::Error | 4 | Es ist ein Fehler aufgetreten. |
Eigenschaft Dokumentation
[read-only] qos : const quint8
Diese Eigenschaft enthält die QoS-Stufe, mit der das Abonnement erstellt wurde.
Die QoS-Stufe des Abonnements gibt die maximale QoS-Stufe an, mit der der Client Nachrichten empfängt. Der Herausgeber kann Nachrichten auch auf einem niedrigeren Niveau senden.
Zugriffsfunktionen:
| quint8 | qos() const |
Benachrichtigungssignal:
| void | qosChanged(quint8) |
[read-only] reason : const QString
Diese Eigenschaft enthält die Zeichenfolge für den Grund des Abonnements.
Ein Reason-String wird vom Server verwendet, um zusätzliche Informationen über das Abonnement zu liefern. Die Übermittlung durch den Server ist optional.
Zugriffsfunktionen:
| QString | reason() const |
[read-only] reasonCode : const QMqtt::ReasonCode
Diese Eigenschaft enthält den Grundcode für das Abonnement.
Der Grundcode gibt den Fehlertyp an, wenn ein Abonnement fehlgeschlagen ist, oder den Grad der QoS bei Erfolg.
Zugriffsfunktionen:
| QMqtt::ReasonCode | reasonCode() const |
[read-only] sharedSubscription : const bool
Diese Eigenschaft gibt an, ob das Abonnement gemeinsam genutzt wird.
Zugriffsfunktionen:
| bool | isSharedSubscription() const |
[read-only] sharedSubscriptionName : const QString
Diese Eigenschaft enthält den Namen des gemeinsamen Abonnements.
Zugriffsfunktionen:
| QString | sharedSubscriptionName() const |
[read-only] state : const SubscriptionState
Diese Eigenschaft enthält den Status des Abonnements.
Zugriffsfunktionen:
| QMqttSubscription::SubscriptionState | state() const |
Benachrichtigungssignal:
| void | stateChanged(QMqttSubscription::SubscriptionState state) |
[read-only] topic : const QMqttTopicFilter
Diese Eigenschaft enthält das Thema des Abonnements.
Zugriffsfunktionen:
| QMqttTopicFilter | topic() const |
Dokumentation der Mitgliedsfunktionen
[override virtual noexcept] QMqttSubscription::~QMqttSubscription()
Löscht ein Abonnement. Wenn das topic nicht bereits abgemeldet wurde, wird es automatisch abgemeldet.
[signal] void QMqttSubscription::messageReceived(QMqttMessage msg)
Dieses Signal wird ausgesendet, wenn die neue Nachricht msg empfangen wurde.
[slot] void QMqttSubscription::unsubscribe()
Meldet sich von topic ab.
Hinweis: Dies kann alle gemeinsamen Zeigerinstanzen betreffen, die von QMqttClient::subscribe() zurückgegeben werden.
QMqttUserProperties QMqttSubscription::userProperties() const
Gibt die Benutzereigenschaften zurück, die vom Broker empfangen wurden, wenn das Abonnement akzeptiert wurde.
Hinweis: Diese Funktion liefert nur dann gültige Daten, wenn der Client QMqttClient::MQTT_5_0 als QMqttClient::ProtocolVersion angibt.
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
