QCoapClient Class

QCoapClient *client = new QCoapClient(this);
connect(client, &QCoapClient::finished, this, &TestClass::slotFinished);
client->get(QCoapRequest(Qurl("coap://coap.me/test")));

QCoapRequest request = QCoapRequest(Qurl("coap://coap.me/obs"));
QCoapReply *reply = client->observe(request);
connect(reply, &QCoapReply::notified, this, &TestClass::slotNotified);

client->cancelObserve(reply);

Dokumentation der Mitgliedsfunktionen

[explicit] QCoapClient::QCoapClient(QtCoap::SecurityMode securityMode = QtCoap::SecurityMode::NoSecurity, QObject *parent = nullptr)

Konstruiert ein QCoapClient-Objekt für das angegebene securityMode und setzt parent als übergeordnetes Objekt.

Die Vorgabe für securityMode ist QtCoap::NoSecurity, wodurch die Sicherheit deaktiviert wird.

Dies stellt eine Verbindung über eine QCoapQUdpConnection her; um einen benutzerdefinierten Transport zu verwenden, muss die Unterklasse QCoapConnection verwendet und eine Instanz an einen der anderen Konstruktoren übergeben werden.

[virtual noexcept] QCoapClient::~QCoapClient()

Zerstört das Objekt QCoapClient und gibt alle Ressourcen frei. Beachten Sie, dass QCoapReply Objekte, die von dieser Klasse zurückgegeben werden, den QCoapClient Satz als ihre Eltern haben, was bedeutet, dass sie zusammen mit diesem gelöscht werden.

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

Dies ist eine überladene Funktion.

Bricht die Beobachtung einer Ressource unter Verwendung der Antwort notifiedReply ab, die von der Methode observe() zurückgegeben wird.

Siehe auch observe().

void QCoapClient::cancelObserve(const QUrl &url)

Dies ist eine überladene Funktion.

Bricht die Beobachtung einer durch url identifizierten Ressource ab.

Siehe auch observe().

QCoapReply *QCoapClient::deleteResource(const QCoapRequest &request)

Sendet die request mit der DELETE-Methode und gibt ein neues QCoapReply Objekt zurück.

Siehe auch get(), put(), post(), observe(), und discover().

QCoapReply *QCoapClient::deleteResource(const QUrl &url)

Dies ist eine überladene Funktion.

Sendet eine DELETE-Anfrage an das Ziel url.

Siehe auch get(), put(), post(), observe(), und discover().

void QCoapClient::disconnect()

Schließt die offenen Sockets und Verbindungen, um den Transport freizugeben.

Siehe auch setSecurityConfiguration().

QCoapResourceDiscoveryReply *QCoapClient::discover(const QUrl &url, const QString &discoveryPath = QLatin1String("/.well-known/core"))

Ermittelt die unter der angegebenen Adresse url verfügbaren Ressourcen und gibt ein neues Objekt QCoapResourceDiscoveryReply zurück, das das Signal QCoapResourceDiscoveryReply::discovered() ausgibt, sobald die Antwort eintrifft.

Der Erkennungspfad ist standardmäßig "/.well-known/core", kann aber geändert werden, indem ein anderer Pfad an discoveryPath übergeben wird. Die Erkennung wird in RFC 6690 beschrieben.

Siehe auch get(), post(), put(), deleteResource(), und observe().

QCoapResourceDiscoveryReply *QCoapClient::discover(QtCoap::MulticastGroup group = QtCoap::MulticastGroup::AllCoapNodesIPv4, int port = QtCoap::DefaultPort, const QString &discoveryPath = QLatin1String("/.well-known/core"))

Dies ist eine überladene Funktion.

Ermittelt die Ressourcen, die an den Endpunkten verfügbar sind, die sich dem group unter der angegebenen port angeschlossen haben. Gibt ein neues QCoapResourceDiscoveryReply Objekt zurück, das das Signal QCoapResourceDiscoveryReply::discovered() aussendet, sobald eine Antwort eintrifft. Die group ist eine der CoAP-Multicast-Gruppenadressen und standardmäßig QtCoap::AllCoapNodesIPv4.

Der Erkennungspfad ist standardmäßig "/.well-known/core", kann aber geändert werden, indem ein anderer Pfad an discoveryPath übergeben wird. Die Erkennung wird in RFC 6690 beschrieben.

Siehe auch get(), post(), put(), deleteResource(), und observe().

[signal] void QCoapClient::error(QCoapReply *reply, QtCoap::Error error)

Dieses Signal wird ausgegeben, wenn ein Fehler auftritt. Der Parameter reply kann nullptr sein, wenn der Fehler nicht mit einem bestimmten QCoapReply zusammenhängt. Der Parameter error enthält den Fehlercode.

Siehe auch finished(), QCoapReply::error(), und QCoapReply::finished().

[signal] void QCoapClient::finished(QCoapReply *reply)

Dieses Signal wird zusammen mit dem Signal QCoapReply::finished() ausgegeben, wenn eine CoAP-Antwort empfangen wurde, entweder nach einem Erfolg oder einem Fehler. Der Parameter reply enthält einen Zeiger auf die gerade empfangene Antwort.

Siehe auch error(), QCoapReply::finished(), und QCoapReply::error().

QCoapReply *QCoapClient::get(const QCoapRequest &request)

Sendet die request mit der GET-Methode und gibt ein neues QCoapReply Objekt zurück.

Siehe auch post(), put(), deleteResource(), observe(), und discover().

QCoapReply *QCoapClient::get(const QUrl &url)

Dies ist eine überladene Funktion.

Sendet eine GET-Anfrage an url und gibt ein neues QCoapReply Objekt zurück.

Siehe auch post(), put(), deleteResource(), observe(), und discover().

QCoapReply *QCoapClient::observe(const QCoapRequest &request)

Sendet eine Anfrage zur Beobachtung des Ziels request und gibt ein neues QCoapReply Objekt zurück, das das Signal QCoapReply::notified() aussendet, sobald eine neue Benachrichtigung eintrifft.

Siehe auch cancelObserve(), get(), post(), put(), deleteResource(), und discover().

QCoapReply *QCoapClient::observe(const QUrl &url)

Dies ist eine überladene Funktion.

Sendet eine Anfrage zur Beobachtung des Ziels url und gibt ein neues QCoapReply Objekt zurück, das das Signal QCoapReply::notified() aussendet, sobald eine neue Benachrichtigung eintrifft.

Siehe auch cancelObserve(), get(), post(), put(), deleteResource(), und discover().

QCoapReply *QCoapClient::post(const QCoapRequest &request, const QByteArray &data = QByteArray())

Sendet die request mit der POST-Methode und gibt ein neues QCoapReply Objekt zurück. Verwendet data als Nutzdaten für diese Anfrage. Wenn data leer ist, wird die Nutzlast von request verwendet.

Siehe auch get(), put(), deleteResource(), observe(), und discover().

QCoapReply *QCoapClient::post(const QCoapRequest &request, QIODevice *device)

Dies ist eine überladene Funktion.

Sendet die request mit der POST-Methode und gibt ein neues QCoapReply Objekt zurück. Verwendet den Inhalt von device als Nutzlast für diese Anfrage. Ein Null-Gerät wird als leerer Inhalt behandelt.

Siehe auch get(), put(), deleteResource(), observe(), und discover().

QCoapReply *QCoapClient::post(const QUrl &url, const QByteArray &data = QByteArray())

Dies ist eine überladene Funktion.

Sendet eine POST-Anfrage an url und gibt ein neues QCoapReply Objekt zurück. Verwendet data als Nutzdaten für diese Anfrage.

Siehe auch get(), put(), deleteResource(), observe(), und discover().

QCoapReply *QCoapClient::put(const QCoapRequest &request, const QByteArray &data = QByteArray())

Sendet die request mit der PUT-Methode und gibt ein neues QCoapReply Objekt zurück. Verwendet data als Nutzdaten für diese Anfrage. Wenn data leer ist, wird die Nutzlast von request verwendet.

Siehe auch get(), post(), deleteResource(), observe(), und discover().

QCoapReply *QCoapClient::put(const QCoapRequest &request, QIODevice *device)

Dies ist eine überladene Funktion.

Sendet die request mit der PUT-Methode und gibt ein neues QCoapReply Objekt zurück. Verwendet den Inhalt von device als Nutzlast für diese Anfrage. Ein Null-Gerät wird als leerer Inhalt behandelt.

Siehe auch get(), post(), deleteResource(), observe(), und discover().

QCoapReply *QCoapClient::put(const QUrl &url, const QByteArray &data = QByteArray())

Dies ist eine überladene Funktion.

Sendet eine PUT-Anfrage an url und gibt ein neues QCoapReply Objekt zurück. Verwendet data als Nutzdaten für diese Anfrage.

Siehe auch get(), post(), deleteResource(), observe(), und discover().

[signal] void QCoapClient::responseToMulticastReceived(QCoapReply *reply, const QCoapMessage &message, const QHostAddress &sender)

Dieses Signal wird ausgesendet, wenn eine Unicast-Antwort auf eine Multicast-Anfrage eintrifft. Der Parameter reply enthält einen Zeiger auf die soeben empfangene Antwort, message enthält die Nutzlast und die Details der Nachricht, und sender enthält die Absenderadresse.

Siehe auch error(), QCoapReply::finished(), und QCoapReply::error().

void QCoapClient::setAckRandomFactor(double ackRandomFactor)

Setzt den in RFC 7252 - Abschnitt 4.2 definierten Wert ACK_RANDOM_FACTOR auf ackRandomFactor. Dieser Wert sollte größer oder gleich 1 sein. Der Standardwert ist 1,5.

Siehe auch setAckTimeout().

void QCoapClient::setAckTimeout(uint ackTimeout)

Setzt den in RFC 7252 - Abschnitt 4.2 definierten Wert ACK_TIMEOUT auf ackTimeout in Millisekunden. Der Standardwert ist 2000 ms.

Diese Zeitüberschreitung gilt nur für bestätigungsfähige Nachrichten. Der tatsächliche Timeout für zuverlässige Übertragungen ist ein Zufallswert zwischen ACK_TIMEOUT und ACK_TIMEOUT * ACK_RANDOM_FACTOR.

Siehe auch setAckRandomFactor().

void QCoapClient::setBlockSize(quint16 blockSize)

Legt die maximale Blockgröße fest, die das Protokoll beim Senden von Anfragen und Empfangen von Antworten an blockSize verwendet. Die Blockgröße muss eine Potenz von zwei sein.

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

Setzt den in RFC 7252 - Abschnitt 4.2 definierten Wert MAX_RETRANSMIT auf maximumRetransmitCount. Dieser Wert sollte kleiner als oder gleich 25 sein. Der Standardwert ist 4.

void QCoapClient::setMaximumServerResponseDelay(uint responseDelay)

Setzt den Wert MAX_SERVER_RESPONSE_DELAY auf responseDelay in Millisekunden. Der Standardwert ist 250 Sekunden.

Wie in RFC 7390 - Abschnitt 2.5 definiert, ist MAX_SERVER_RESPONSE_DELAY die erwartete maximale Antwortverzögerung für alle Server, an die der Client eine Multicast-Anfrage senden kann.

void QCoapClient::setMinimumTokenSize(int tokenSize)

Legt die Mindestgröße des Tokens auf tokenSize in Bytes fest. Aus Sicherheitsgründen wird empfohlen, Token mit einer Länge von mindestens 4 Byte zu verwenden. Der Standardwert für diesen Parameter ist 4 Byte.

void QCoapClient::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)

Setzt die Sicherheitskonfigurationsparameter von configuration. Die Konfiguration wird ignoriert, wenn der Modus QtCoap::NoSecurity verwendet wird.

Siehe auch disconnect().

void QCoapClient::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

Setzt den Socket QUdpSocket option auf value.