QMqttClient Class

Member Function Dokumentation

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

Erzeugt eine neue MQTT-Client-Instanz mit der angegebenen parent.

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

Löscht einen MQTT-Client. Wenn der MQTT-Client nicht bereits vom MQTT-Broker getrennt wurde, wird er automatisch getrennt.

void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)

Sendet eine Authentifizierungsanfrage an den Broker. prop gibt die erforderlichen Informationen an, um die Authentifizierungsanfrage zu erfüllen.

Diese Funktion sollte nur aufgerufen werden, nachdem ein QMqttClient::authenticationRequested Signal gesendet wurde.

Siehe auch authenticationRequested() und authenticationFinished().

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

Dieses Signal wird ausgegeben, nachdem die erweiterte Authentifizierung abgeschlossen ist. p gibt die verfügbaren Details zum Authentifizierungsprozess an.

Nach erfolgreicher Authentifizierung wird QMqttClient::connected ausgegeben.

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 Details anfordern, die durch den Aufruf von QMqttClient::authenticate bereitgestellt werden müssen. p spezifiziert die vom Broker bereitgestellten Eigenschaften.

Siehe auch authenticationFinished() und authenticate().

[signal] void QMqttClient::brokerSessionRestored()

Dieses Signal wird ausgegeben, nachdem ein Client erfolgreich eine Verbindung zu einem Broker mit der Eigenschaft cleanSession auf false hergestellt hat und der Broker die Sitzung wiederhergestellt hat.

Sitzungen können wiederhergestellt werden, wenn ein Client zuvor eine Verbindung mit der gleichen clientId hergestellt hat.

[invokable] void QMqttClient::connectToHost()

Initiiert eine Verbindung mit dem MQTT-Broker.

void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)

Initiiert eine verschlüsselte Verbindung zum MQTT-Broker.

conf gibt die SSL-Konfiguration an, die für die Verbindung verwendet werden soll

[signal] void QMqttClient::connected()

Dieses Signal wird ausgegeben, wenn eine Verbindung zustande gekommen ist.

QMqttConnectionProperties QMqttClient::connectionProperties() const

Gibt die Verbindungseigenschaften zurück, die der Client beim Broker anfordert.

Siehe auch setConnectionProperties().

[invokable] void QMqttClient::disconnectFromHost()

Trennt die Verbindung mit dem MQTT-Broker.

[signal] void QMqttClient::disconnected()

Dieses Signal wird ausgegeben, 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 Willens zurück.

Siehe auch setLastWillProperties().

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

Dieses Signal wird ausgesendet, wenn eine neue Nachricht empfangen wurde. Die Kategorie der Nachricht wird durch topic angegeben, der Inhalt ist message.

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

Zeigt an, dass eine Nachricht, die über die Funktion publish() gesendet wurde, vom Broker empfangen wurde. Die Adresse id ist die gleiche wie die von publish() zurückgegebene, um den Status der Nachricht zu verfolgen.

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

Dieses Signal wird ausgegeben, wenn sich der Status für die durch id identifizierte Nachricht ändert. s gibt den neuen Status der Nachricht an, und properties spezifiziert zusätzliche Eigenschaften, die vom Server bereitgestellt werden.

[signal] void QMqttClient::pingResponseReceived()

Dieses Signal wird ausgegeben, nachdem der Broker auf einen requestPing()-Aufruf oder eine keepAlive()-Ping-Nachricht geantwortet hat und die Verbindung noch gültig ist.

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

Publiziert eine message an den Broker mit dem angegebenen topic. qos gibt die für die Übertragung der Nachricht erforderliche QoS-Stufe an.

Wenn retain auf true eingestellt ist, verbleibt die Nachricht beim Broker, damit 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 an den Broker mit den angegebenen properties und topic. qos gibt die für die Übertragung der Nachricht erforderliche QoS-Stufe an.

Wenn retain auf true eingestellt ist, verbleibt die Nachricht beim Broker, damit 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 steht, schlägt der Aufruf dieser Funktion fehl, da der Client für die Verwaltung dieses Prozesses verantwortlich ist.

Die manuelle Verwendung von requestPing() erfordert jedes Mal einen Aufruf innerhalb des Intervalls keepAlive, 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 die QMqttServerConnectionProperties zurück, die der Broker nach einem Verbindungsversuch zurückgegeben hat.

Dies kann verwendet werden, um zu überprüfen, ob die von QMqttClient::setConnectionProperties eingestellten clientseitigen Verbindungseigenschaften vom Makler akzeptiert worden sind. Außerdem kann es im Falle eines fehlgeschlagenen Verbindungsversuchs für die Verbindungsdiagnose verwendet werden.

Siehe auch connectionProperties().

void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)

Setzt die Verbindungseigenschaften auf prop. QMqttConnectionProperties kann verwendet werden, um den Server aufzufordern, einen bestimmten Funktionssatz zu verwenden. Nach einer Verbindungsanfrage kann die Antwort des Servers durch den Aufruf von QMqttClient::serverConnectionProperties abgerufen werden.

Siehe auch connectionProperties().

void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)

Setzt die Eigenschaften des letzten Willens auf prop. QMqttLastWillProperties ermöglicht es, zusätzliche Eigenschaften für die beim Broker gespeicherte letzte Willensnachricht festzulegen.

Siehe auch lastWillProperties().

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

Setzt den Transport auf device. Ein Transport kann entweder ein Socket-Typ sein oder von QIODevice abgeleitet werden und wird durch transport angegeben.

Siehe auch transport().

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

Fügt ein neues Abonnement zum Empfang von Benachrichtigungen auf topic hinzu. 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 QMqttSubscription zurück. Wenn dasselbe Topic zweimal abonniert wird, zeigt 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 zum Empfang von Benachrichtigungen auf topic hinzu. Der Parameter properties gibt zusätzliche Eigenschaften des Abonnements an, die vom Makler zu überprüfen sind. Der Parameter qos gibt die Ebene an, auf der Sicherheitsnachrichten empfangen werden. Weitere Informationen zu den verfügbaren QoS-Stufen finden Sie unter Quality of Service.

Diese Funktion gibt einen Zeiger auf QMqttSubscription zurück. Wenn dasselbe Topic zweimal abonniert wird, zeigt der Rückgabewert auf dieselbe Abonnementinstanz. Der MQTT-Client ist der Eigentümer des Abonnements.

QIODevice *QMqttClient::transport() const

Gibt den für die Kommunikation mit dem Makler verwendeten Transport zurück.

Siehe auch setTransport().

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic)

Meldet sich von topic ab. Es werden keine Benachrichtigungen an die Abonnements gesendet, die durch den Aufruf von subscribe() erstellt wurden.

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

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