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)

Erstellt ein QCoapClient-Objekt für den angegebenen „ securityMode “ und legt „ parent “ als übergeordnetes Objekt fest.

Der Standardwert für „ securityMode “ ist „ QtCoap::NoSecurity “, wodurch die Sicherheit deaktiviert wird.

[virtual noexcept] QCoapClient::~QCoapClient()

Löscht das „ QCoapClient “-Objekt und gibt alle Ressourcen frei. Beachten Sie, dass bei den von dieser Klasse zurückgegebenen „ QCoapReply “-Objekten „ QCoapClient “ als übergeordnetes Objekt festgelegt ist, was bedeutet, dass sie zusammen mit diesem gelöscht werden.

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

Hebt die Beobachtung einer Ressource auf, wobei die Antwort „ notifiedReply “ verwendet wird, die von der Methode „ observe()“ zurückgegeben wurde.

Siehe auch ` observe()`.

void QCoapClient::cancelObserve(const QUrl &url)

Hebt die Beobachtung einer Ressource auf, die durch die url identifiziert wird.

Siehe auch observe().

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

Sendet die „ request “ mithilfe 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)

Sendet eine DELETE-Anfrage an die 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 QCoapResourceDiscoveryReply -Objekt zurück, das das Signal QCoapResourceDiscoveryReply::discovered() aussendet, sobald die Antwort eintrifft.

Der Erkennungspfad ist standardmäßig „/.well-known/core“, kann jedoch durch Übergabe eines anderen Pfads an discoveryPath geändert werden. Die Erkennung ist 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"))

Ermittelt die verfügbaren Ressourcen an den Endpunkten, die dem „ group “ unter der angegebenen Adresse port beigetreten sind. 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 lautet standardmäßig QtCoap::AllCoapNodesIPv4.

Der Discovery-Pfad ist standardmäßig „/.well-known/core“, kann jedoch durch Übergabe eines anderen Pfads an ` discoveryPath` geändert werden. Die Discovery 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 immer dann ausgelöst, wenn ein Fehler auftritt. Der Parameter „ reply “ kann auf „ nullptr “ gesetzt werden, 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()“ ausgelöst, sobald eine CoAP-Antwort empfangen wird – unabhängig davon, ob diese erfolgreich war oder einen Fehler enthielt. Der Parameter „ reply “ enthält einen Zeiger auf die soeben 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)

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() auslöst, sobald eine neue Benachrichtigung eintrifft.

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

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

Sendet eine Anfrage zur Beobachtung des Ziel- url s und gibt ein neues QCoapReply -Objekt zurück, das das Signal QCoapReply::notified() ausgibt, 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. Ist „ data “ leer, werden die Nutzdaten der „ request “ verwendet.

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

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

Sendet die „ request “ mithilfe der POST-Methode und gibt ein neues „ QCoapReply “-Objekt zurück. Verwendet den Inhalt von „ device “ als Nutzdaten für diese Anfrage. Ein Null-Gerät wird als leerer Inhalt behandelt; in diesem Fall werden die Nutzdaten von „ request “ verwendet.

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

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

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 Datei „ request “ mit der PUT-Methode und gibt ein neues „ QCoapReply “-Objekt zurück. Verwendet „ data “ als Nutzdaten für diese Anfrage. Ist „ data “ leer, werden die Nutzdaten von „ request “ verwendet.

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

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

Sendet die „ request “ mithilfe der PUT-Methode und gibt ein neues „ QCoapReply “-Objekt zurück. Verwendet den Inhalt von „ device “ als Nutzdaten für diese Anfrage. Ein Null-Gerät wird als leerer Inhalt behandelt; in diesem Fall werden die Nutzdaten von „ request “ verwendet.

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

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

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 ausgelöst, 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 Nutzdaten 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 beträgt 2000 ms.

Dieses Timeout gilt nur für bestätigungsfähige Nachrichten. Das 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 beim Empfangen von Antworten verwendet: blockSize. Die Blockgröße muss eine Zweierpotenz sein.

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

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

void QCoapClient::setMaximumServerResponseDelay(uint responseDelay)

Legt den Wert für „ MAX_SERVER_RESPONSE_DELAY “ auf „ responseDelay “ in Millisekunden fest. Der Standardwert beträgt 250 Sekunden.

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

void QCoapClient::setMinimumTokenSize(int tokenSize)

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

void QCoapClient::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)

Legt die Sicherheitskonfigurationsparameter aus configuration fest. Die Konfiguration wird ignoriert, wenn der Modus „ QtCoap::NoSecurity “ verwendet wird.

Siehe auch disconnect().

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

Setzt die Socket- option en von „ QUdpSocket “ auf „ value “.