QCoapMessage Class
Die Klasse QCoapMessage enthält Informationen über eine CoAP-Nachricht, die eine Anfrage oder eine Antwort sein kann. Mehr...
| Kopfzeile: | #include <QCoapMessage> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Coap)target_link_libraries(mytarget PRIVATE Qt6::Coap) |
| qmake: | QT += coap |
| Vererbt von: |
Hinweis: Alle Funktionen in 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) |
Detaillierte Beschreibung
Sie enthält Informationen wie den Nachrichtentyp, die Nachrichten-ID, das Token und andere Zusatzdaten.
Siehe auch QCoapOption, QCoapReply, und QCoapRequest.
Dokumentation der Mitgliedstypen
enum class QCoapMessage::Type
Gibt den Typ der Nachricht an.
| Konstante | Wert | Beschreibung |
|---|---|---|
QCoapMessage::Type::Confirmable | 0 | Eine bestätigungsfähige Meldung. Der Zielendpunkt muss die Meldung bestätigen. |
QCoapMessage::Type::NonConfirmable | 1 | Eine nicht bestätigungsfähige Meldung. Der Zielendpunkt braucht die Meldung nicht zu bestätigen. |
QCoapMessage::Type::Acknowledgment | 2 | Eine Acknowledgment-Meldung. Eine Meldung, die als Antwort auf eine Confirmable-Meldung gesendet oder empfangen wird. |
QCoapMessage::Type::Reset | 3 | Eine Reset-Meldung. Dieser Meldungstyp wird bei Fehlern oder zum Anhalten der laufenden Übertragung verwendet. (Sie wird zum Beispiel verwendet, um eine Beobachtung abzubrechen). |
Dokumentation der Mitgliedsfunktionen
QCoapMessage::QCoapMessage()
Konstruiert eine neue QCoapMessage.
QCoapMessage::QCoapMessage(const QCoapMessage &other)
Konstruiert eine oberflächliche Kopie von other.
[noexcept] QCoapMessage::~QCoapMessage()
Zerstört die QCoapMessage.
void QCoapMessage::addOption(const QCoapOption &option)
Fügt das angegebene CoAP option hinzu.
void QCoapMessage::addOption(QCoapOption::OptionName name, const QByteArray &value = QByteArray())
Dies ist eine überladene Funktion.
Fügt die CoAP-Option mit der angegebenen name und value hinzu.
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
Findet und gibt die erste Option mit der angegebenen name zurück. Wenn es keine solche Option gibt, wird ein ungültiger 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
Findet und gibt die Liste der Optionen mit der angegebenen name zurück.
QByteArray QCoapMessage::payload() const
Gibt die Nutzlast zurück.
Siehe auch setPayload().
void QCoapMessage::removeOption(QCoapOption::OptionName name)
Entfernt alle Optionen mit der angegebenen name. Das CoAP-Protokoll lässt die Wiederholung derselben Option zu.
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 Nutzlast der Nachricht auf payload. Die Nutzlast kann in einem der im 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 in der Nutzlast als auch in der Verarbeitung sehr schwer. Eines der empfohlenen Inhaltsformate für die Verwendung mit CoAP ist CBOR, das für die Verwendung in solchen Kontexten konzipiert ist.
Siehe auch payload(), QCborStreamWriter, und QCborStreamReader.
void QCoapMessage::setToken(const QByteArray &token)
Setzt das Message-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)
Setzt die CoAP-Version auf version.
Siehe auch version().
[noexcept] void QCoapMessage::swap(QCoapMessage &other)
Tauscht diese Nachricht mit other aus. Dieser Vorgang ist sehr schnell und schlägt nie fehl.
QByteArray QCoapMessage::token() const
Gibt das Nachrichten-Token zurück.
Siehe auch setToken().
quint8 QCoapMessage::tokenLength() const
Gibt die Tokenlänge 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 einen Verweis auf diese QCoapMessage zurück.
QCoapMessage &QCoapMessage::operator=(const QCoapMessage &other)
Kopiert den Inhalt von other in diese Nachricht. Gibt einen Verweis auf diese QCoapMessage zurück.
© 2025 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.
