QMqttClient Class

Dokumentation der Mitgliedsfunktionen

[explicit] QMqttClient::QMqttClient(QObject *parent = nullptr)

Erstellt eine neue MQTT-Client-Instanz mit der angegebenen „ parent “.

[override virtual noexcept] QMqttClient::~QMqttClient()

Löscht einen MQTT-Client. Falls der MQTT-Client noch nicht vom MQTT-Broker getrennt war, wird die Verbindung automatisch getrennt.

void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)

Sendet eine Authentifizierungsanfrage an den Broker. „ prop “ gibt die erforderlichen Informationen zur Bearbeitung der Authentifizierungsanfrage an.

Diese Funktion sollte erst aufgerufen werden, nachdem ein „ QMqttClient::authenticationRequested “-Signal ausgegeben wurde.

Siehe auch authenticationRequested() und authenticationFinished().

[signal] void QMqttClient::authenticationFinished(const QMqttAuthenticationProperties &p)

Dieses Signal wird nach Abschluss der erweiterten Authentifizierung ausgegeben. „ p “ enthält weitere Informationen zum Authentifizierungsprozess.

Nach erfolgreicher Authentifizierung wird „ QMqttClient::connected “ gesendet.

Siehe auch authenticationRequested() und authenticate().

[signal] void QMqttClient::authenticationRequested(const QMqttAuthenticationProperties &p)

Dieses Signal wird ausgegeben, nachdem ein Client „ QMqttClient::connectToHost “ oder „ QMqttClient::connectToHostEncrypted “ aufgerufen hat und bevor die Verbindung hergestellt wird. Bei der erweiterten Authentifizierung kann ein Broker zusätzliche Angaben anfordern, die durch den Aufruf von „ QMqttClient::authenticate “ bereitgestellt werden müssen. „ p “ gibt die vom Broker bereitgestellten Eigenschaften an.

Siehe auch authenticationFinished() und authenticate().

[signal] void QMqttClient::brokerSessionRestored()

Dieses Signal wird ausgelöst, nachdem ein Client erfolgreich eine Verbindung zu einem Broker hergestellt hat, wobei die Eigenschaft „ cleanSession “ auf „ false “ gesetzt ist, und der Broker die Sitzung wiederhergestellt hat.

Sitzungen können wiederhergestellt werden, wenn ein Client zuvor eine Verbindung unter Verwendung desselben „ clientId “ hergestellt hat.

[invokable] void QMqttClient::connectToHost()

Stellt eine Verbindung zum MQTT-Broker her.

void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)

Stellt eine verschlüsselte Verbindung zum MQTT-Broker her.

conf Legt die für die Verbindung zu verwendende SSL-Konfiguration fest.

[invokable, since 6.10] void QMqttClient::connectToHostWebSocket(QWebSocket *webSocket = nullptr)

Legt einen WebSocket-Transporttyp fest und baut eine Verbindung zum MQTT-Broker auf. Der bisherige Transporttyp wird ersetzt. Wird „ webSocket “ angegeben, werden Hostname und Port ignoriert, und die Verbindung wird über diesen WebSocket hergestellt. „webSocket“ gehört dem aufrufenden Code und muss für die gesamte Lebensdauer des „ QMqttClient “-Objekts gültig sein.

Diese Funktion wurde in Qt 6.10 eingeführt.

[invokable, since 6.10] void QMqttClient::connectToHostWebSocketEncrypted(QWebSocket *webSocket = nullptr)

Legt einen sicheren WebSocket-Transporttyp fest und baut eine Verbindung zum MQTT-Broker auf. Der bisherige Transporttyp wird ersetzt. Wird „ webSocket “ angegeben, werden Hostname und Port ignoriert, und die Verbindung wird über diesen WebSocket hergestellt. „webSocket“ gehört dem aufrufenden Code und muss für die gesamte Lebensdauer des „ QMqttClient “-Objekts gültig sein.

Diese Funktion wurde in Qt 6.10 eingeführt.

[signal] void QMqttClient::connected()

Dieses Signal wird ausgesendet, wenn eine Verbindung hergestellt wurde.

QMqttConnectionProperties QMqttClient::connectionProperties() const

Gibt die vom Client angeforderten Verbindungseigenschaften an den Broker zurück.

Siehe auch setConnectionProperties().

[invokable] void QMqttClient::disconnectFromHost()

Trennt die Verbindung zum MQTT-Broker.

[signal] void QMqttClient::disconnected()

Dieses Signal wird ausgelöst, wenn eine Verbindung geschlossen wurde. Eine Verbindung kann geschlossen werden, wenn disconnectFromHost() aufgerufen wird oder wenn der Broker die Verbindung trennt.

QMqttLastWillProperties QMqttClient::lastWillProperties() const

Gibt die Eigenschaften des letzten Testaments zurück.

Siehe auch setLastWillProperties().

[signal] void QMqttClient::messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName())

Dieses Signal wird ausgelöst, wenn eine neue Nachricht eingegangen ist. Die Kategorie der Nachricht wird durch „ topic “ angegeben, der Inhalt lautet „ message “.

[signal] void QMqttClient::messageSent(qint32 id)

Gibt an, dass eine über die Funktion „ publish()“ gesendete Nachricht vom Broker empfangen wurde. Die ID „ id “ entspricht der von „ publish() “ zurückgegebenen ID, um die Nachverfolgung des Status der Nachricht zu erleichtern.

[signal] void QMqttClient::messageStatusChanged(qint32 id, QMqtt::MessageStatus s, const QMqttMessageStatusProperties &properties)

Dieses Signal wird ausgelöst, wenn sich der Status der durch „ id “ identifizierten Nachricht ändert. „ s “ gibt den neuen Status der Nachricht an, und „ properties “ geben zusätzliche vom Server bereitgestellte Eigenschaften an.

[signal] void QMqttClient::pingResponseReceived()

Dieses Signal wird ausgegeben, nachdem der Broker auf einen Aufruf von ` requestPing()` oder eine Ping-Nachricht von ` keepAlive()` geantwortet hat und die Verbindung weiterhin besteht.

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

Veröffentlicht eine „ message “ beim Broker mit der angegebenen „ topic “. „ qos “ gibt die für die Übertragung der Nachricht erforderliche QoS-Stufe an.

Wenn „ retain “ auf „ true “ gesetzt ist, verbleibt die Nachricht auf dem Broker, sodass andere Clients eine Verbindung herstellen und die Nachricht empfangen können.

Gibt eine ID zurück, die intern zur Identifizierung der Nachricht verwendet wird.

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QMqttPublishProperties &properties, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

Veröffentlicht eine „ message “ beim Broker mit den angegebenen Werten für „ properties “ und „ topic “. „ qos “ gibt die für die Übertragung der Nachricht erforderliche QoS-Stufe an.

Wenn „ retain “ auf „ true “ gesetzt ist, verbleibt die Nachricht auf dem Broker, sodass andere Clients eine Verbindung herstellen und die Nachricht empfangen können.

Gibt eine ID zurück, die intern zur Identifizierung der Nachricht verwendet wird.

bool QMqttClient::requestPing()

Sendet eine Ping-Nachricht an den Broker und erwartet eine Antwort.

Wenn die Verbindung aktiv ist und „ autoKeepAlive “ auf „ true “ gesetzt ist, schlägt der Aufruf dieser Funktion fehl, da der Client für die Verwaltung dieses Prozesses verantwortlich ist.

Die manuelle Verwendung von ` requestPing() ` erfordert einen Aufruf in jedem ` keepAlive `-Intervall, solange die Verbindung aktiv ist.

Um zu überprüfen, ob der Ping erfolgreich war, verbinden Sie sich mit dem Signal ` pingResponseReceived()`.

Gibt ` true ` zurück, wenn die Ping-Anfrage gesendet werden konnte.

Siehe auch pingResponseReceived(), autoKeepAlive() und keepAlive().

QMqttServerConnectionProperties QMqttClient::serverConnectionProperties() const

Gibt den von dem Broker nach einem Verbindungsversuch zurückgegebenen ` QMqttServerConnectionProperties ` zurück.

Dies kann verwendet werden, um zu überprüfen, ob die durch „ QMqttClient::setConnectionProperties “ festgelegten Verbindungs-Eigenschaften auf Client-Seite vom Broker akzeptiert wurden. Außerdem kann es im Falle eines fehlgeschlagenen Verbindungsversuchs zur Verbindungsdiagnose genutzt werden.

Siehe auch connectionProperties().

void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)

Setzt die Verbindungseigenschaften auf „ prop “. Mit „ QMqttConnectionProperties “ kann der Server aufgefordert werden, einen bestimmten Funktionsumfang zu verwenden. Nach einer Verbindungsanfrage kann die Serverantwort durch Aufruf von „ QMqttClient::serverConnectionProperties “ abgerufen werden.

Siehe auch „ connectionProperties“ ().

void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)

Setzt die Eigenschaften des „Last Will“ auf „ prop “. Mit „ QMqttLastWillProperties “ können zusätzliche Funktionen für die beim Broker gespeicherte „Last Will“-Nachricht festgelegt werden.

Siehe auch „ lastWillProperties“ ().

void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType transport)

Setzt den Transport auf „ device “. Ein Transport kann entweder vom Typ „Socket“ sein oder von „ QIODevice “ abgeleitet sein und wird durch „ transport “ angegeben.

Siehe auch „ transport()“.

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, quint8 qos = 0)

Fügt ein neues Abonnement hinzu, um Benachrichtigungen unter topic zu erhalten. Der Parameter „ qos “ gibt die Stufe an, auf der Sicherheitsmeldungen empfangen werden. Weitere Informationen zu den verfügbaren QoS-Stufen finden Sie unter „Quality of Service“.

Diese Funktion gibt einen Zeiger auf ein ` QMqttSubscription` zurück. Wird dasselbe Thema zweimal abonniert, verweist der Rückgabewert auf dieselbe Abonnementinstanz. Der MQTT-Client ist der Eigentümer des Abonnements.

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, const QMqttSubscriptionProperties &properties, quint8 qos = 0)

Fügt ein neues Abonnement hinzu, um Benachrichtigungen unter topic zu erhalten. Der Parameter „ properties “ gibt zusätzliche Abonnement-Eigenschaften an, die vom Broker überprüft werden sollen. Der Parameter „ qos “ gibt die Stufe an, auf der Sicherheitsmeldungen empfangen werden. Weitere Informationen zu den verfügbaren QoS-Stufen finden Sie unter „Quality of Service“.

Diese Funktion gibt einen Zeiger auf ein ` QMqttSubscription` zurück. Wird dasselbe Thema zweimal abonniert, verweist der Rückgabewert auf dieselbe Abonnementinstanz. Der MQTT-Client ist der Eigentümer des Abonnements.

QIODevice *QMqttClient::transport() const

Gibt den Transport zurück, der für die Kommunikation mit dem Broker verwendet wird.

Siehe auch „ setTransport()“.

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic)

Abmeldung von topic. Es werden keine Benachrichtigungen an die Abonnements gesendet, die über den Aufruf von subscribe() eingerichtet wurden.

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties)

Abmeldung von topic. Es werden keine Benachrichtigungen an die Abonnements gesendet, die über den Aufruf von subscribe() erstellt wurden. properties gibt zusätzliche Benutzereigenschaften an, die an den Broker übergeben werden sollen.