QCoapMessage Class
Die Klasse „QCoapMessage“ enthält Informationen zu einer CoAP-Nachricht, bei der es sich um eine Anfrage oder eine Antwort handeln kann. Mehr...
| Header: | #include <QCoapMessage> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Coap) target_link_libraries(mytarget PRIVATE Qt6::Coap) |
| qmake: | QT += coap |
| Vererbt an: |
Hinweis: Alle Funktionen dieser Klasse sind reentrant.
Öffentliche Typen
| enum class | Type { Confirmable, NonConfirmable, Acknowledgment, Reset } |
Öffentliche Funktionen
| QCoapMessage() | |
| QCoapMessage(const QCoapMessage &other) | |
| ~QCoapMessage() | |
| void | addOption(const QCoapOption &option) |
| void | addOption(QCoapOption::OptionName name, const QByteArray &value = QByteArray()) |
| void | clearOptions() |
| bool | hasOption(QCoapOption::OptionName name) const |
| quint16 | messageId() const |
| QCoapOption | option(QCoapOption::OptionName name) const |
| QCoapOption | optionAt(int index) const |
| int | optionCount() const |
| const QList<QCoapOption> & | options() const |
| QList<QCoapOption> | options(QCoapOption::OptionName name) const |
| QByteArray | payload() const |
| void | removeOption(QCoapOption::OptionName name) |
| void | removeOption(const QCoapOption &option) |
| void | setMessageId(quint16 id) |
| void | setOptions(const QList<QCoapOption> &options) |
| void | setPayload(const QByteArray &payload) |
| void | setToken(const QByteArray &token) |
| void | setType(const QCoapMessage::Type &type) |
| void | setVersion(quint8 version) |
| void | swap(QCoapMessage &other) |
| QByteArray | token() const |
| quint8 | tokenLength() const |
| QCoapMessage::Type | type() const |
| quint8 | version() const |
| QCoapMessage & | operator=(QCoapMessage &&other) |
| QCoapMessage & | operator=(const QCoapMessage &other) |
Ausführliche Beschreibung
Sie enthält Informationen wie den Nachrichtentyp, die Nachrichten-ID, das Token und weitere Zusatzdaten.
Siehe auch „ QCoapOption “, „ QCoapReply “ und „ QCoapRequest “.
Dokumentation zum Mitgliedstyp
enum class QCoapMessage::Type
Gibt den Typ der Nachricht an.
| Konstante | Wert | Beschreibung |
|---|---|---|
QCoapMessage::Type::Confirmable | 0 | Eine bestätigungsfähige Nachricht. Der Zielendpunkt muss die Nachricht bestätigen. |
QCoapMessage::Type::NonConfirmable | 1 | Eine nicht bestätigungsfähige Nachricht. Der Zielendpunkt muss die Nachricht nicht bestätigen. |
QCoapMessage::Type::Acknowledgment | 2 | Eine Bestätigungsnachricht. Eine Nachricht, die als Antwort auf eine bestätigungsfähige Nachricht gesendet oder empfangen wird. |
QCoapMessage::Type::Reset | 3 | Eine Rücksetz-Nachricht. Dieser Nachrichtentyp wird im Fehlerfall oder zum Beenden der laufenden Übertragung verwendet. (Beispielsweise wird er zum Abbrechen einer Beobachtung verwendet.) |
Dokumentation der Member-Funktionen
QCoapMessage::QCoapMessage()
Erstellt eine neue QCoapMessage.
QCoapMessage::QCoapMessage(const QCoapMessage &other)
Erstellt eine flache Kopie von other.
[noexcept] QCoapMessage::~QCoapMessage()
Zerstört die „ QCoapMessage “.
void QCoapMessage::addOption(const QCoapOption &option)
Fügt den angegebenen CoAP- option, hinzu.
void QCoapMessage::addOption(QCoapOption::OptionName name, const QByteArray &value = QByteArray())
Fügt die CoAP-Option mit den angegebenen Werten „ name “ und „ value “ hinzu.
Dies ist eine überladene Funktion.
void QCoapMessage::clearOptions()
Entfernt alle Optionen.
bool QCoapMessage::hasOption(QCoapOption::OptionName name) const
Gibt „ true “ zurück, wenn die Nachricht mindestens eine Option mit „ name “ enthält.
quint16 QCoapMessage::messageId() const
Gibt die Nachrichten-ID zurück.
Siehe auch „ setMessageId()“.
QCoapOption QCoapMessage::option(QCoapOption::OptionName name) const
Sucht und gibt die erste Option mit dem angegebenen „ name “ zurück. Falls keine solche Option vorhanden ist, wird ein ungültiges „ QCoapOption “ mit einem leeren Wert zurückgegeben.
QCoapOption QCoapMessage::optionAt(int index) const
Gibt die Option an der Position „ index “ zurück.
int QCoapMessage::optionCount() const
Gibt die Anzahl der Optionen zurück.
const QList<QCoapOption> &QCoapMessage::options() const
Gibt die Liste der Optionen zurück.
Siehe auch setOptions().
QList<QCoapOption> QCoapMessage::options(QCoapOption::OptionName name) const
Sucht und gibt die Liste der Optionen mit dem angegebenen „ name “ zurück.
QByteArray QCoapMessage::payload() const
Gibt die Nutzdaten zurück.
Siehe auch ` setPayload()`.
void QCoapMessage::removeOption(QCoapOption::OptionName name)
Entfernt alle Optionen mit dem angegebenen „ name “. Das CoAP-Protokoll lässt zu, dass dieselbe Option mehrfach vorkommt.
void QCoapMessage::removeOption(const QCoapOption &option)
Entfernt die angegebene „ option “.
void QCoapMessage::setMessageId(quint16 id)
Setzt die Nachrichten-ID auf „ id “.
Siehe auch messageId().
void QCoapMessage::setOptions(const QList<QCoapOption> &options)
Setzt die Nachrichtenoptionen auf „ options “.
Siehe auch options().
void QCoapMessage::setPayload(const QByteArray &payload)
Setzt die Nachrichten-Nutzlast auf „ payload “. Die Nutzlast kann in einem der in der CoAP Content-Formats Registry definierten Inhaltsformate dargestellt werden.
Hinweis: CoAP unterstützt gängige Inhaltsformate wie XML, JSON usw., diese sind jedoch textbasiert und daher sowohl hinsichtlich der Nutzlast als auch der Verarbeitung ressourcenintensiv. Eines der für die Verwendung mit CoAP empfohlenen Inhaltsformate ist CBOR, das speziell für den Einsatz in solchen Kontexten entwickelt wurde.
Siehe auch payload(), QCborStreamWriter und QCborStreamReader.
void QCoapMessage::setToken(const QByteArray &token)
Setzt das Nachrichten-Token auf „ token “.
Siehe auch token().
void QCoapMessage::setType(const QCoapMessage::Type &type)
Setzt den Nachrichtentyp auf „ type “.
Siehe auch type().
void QCoapMessage::setVersion(quint8 version)
Legt die CoAP-Version auf „ version “ fest.
Siehe auch version().
[noexcept] void QCoapMessage::swap(QCoapMessage &other)
Tauscht diese Nachricht mit other aus. Dieser Vorgang ist sehr schnell und schlägt niemals fehl.
QByteArray QCoapMessage::token() const
Gibt das Nachrichten-Token zurück.
Siehe auch ` setToken()`.
quint8 QCoapMessage::tokenLength() const
Gibt die Länge des Tokens zurück.
QCoapMessage::Type QCoapMessage::type() const
Gibt den Nachrichtentyp zurück.
Siehe auch „ setType()“.
quint8 QCoapMessage::version() const
Gibt die CoAP-Version zurück.
Siehe auch setVersion().
[noexcept] QCoapMessage &QCoapMessage::operator=(QCoapMessage &&other)
Verschiebt „ other “ in diese Nachricht und gibt eine Referenz auf „ QCoapMessage “ zurück.
QCoapMessage &QCoapMessage::operator=(const QCoapMessage &other)
Kopiert den Inhalt von „ other “ in diese Nachricht. Gibt eine Referenz auf „ QCoapMessage “ zurück.
© 2026 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.
