QCoapMessage Class
La classe `QCoapMessage` contient des informations sur un message CoAP, qui peut être une requête ou une réponse. En savoir plus...
| En-tête : | #include <QCoapMessage> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Coap) target_link_libraries(mytarget PRIVATE Qt6::Coap) |
| qmake : | QT += coap |
| Hérité par : |
Remarque : toutes les fonctions de cette classe sont réentrantes.
Types publics
| enum class | Type { Confirmable, NonConfirmable, Acknowledgment, Reset } |
Fonctions publiques
| 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) |
Description détaillée
Elle contient des informations telles que le type de message, l'identifiant du message, le jeton et d'autres données annexes.
Voir également QCoapOption, QCoapReply et QCoapRequest.
Documentation sur les types de membres
enum class QCoapMessage::Type
Indique le type du message.
| Constante | Valeur | Description |
|---|---|---|
QCoapMessage::Type::Confirmable | 0 | Message confirmable. Le point de terminaison de destination doit accuser réception du message. |
QCoapMessage::Type::NonConfirmable | 1 | Un message non confirmable. Le point de terminaison de destination n'a pas besoin d'accuser réception du message. |
QCoapMessage::Type::Acknowledgment | 2 | Un message d’accusé de réception. Message envoyé ou reçu en réponse à un message confirmable. |
QCoapMessage::Type::Reset | 3 | Un message de réinitialisation. Ce type de message est utilisé en cas d’erreur ou pour interrompre la transmission en cours. (Par exemple, il sert à annuler une observation). |
Documentation des fonctions membres
QCoapMessage::QCoapMessage()
Crée un nouvel objet QCoapMessage.
QCoapMessage::QCoapMessage(const QCoapMessage &other)
Crée une copie superficielle de ` other`.
[noexcept] QCoapMessage::~QCoapMessage()
Supprime l'QCoapMessage.
void QCoapMessage::addOption(const QCoapOption &option)
Ajoute l'option CoAP indiquée.
void QCoapMessage::addOption(QCoapOption::OptionName name, const QByteArray &value = QByteArray())
Ajoute l'option CoAP avec les paramètres name et value indiqués.
Il s'agit d'une fonction surchargée.
void QCoapMessage::clearOptions()
Supprime toutes les options.
bool QCoapMessage::hasOption(QCoapOption::OptionName name) const
Renvoie « true » si le message contient au moins une option avec « name ».
quint16 QCoapMessage::messageId() const
Renvoie l'identifiant du message.
Voir aussi setMessageId().
QCoapOption QCoapMessage::option(QCoapOption::OptionName name) const
Recherche et renvoie la première option correspondant à l'name. Si aucune option de ce type n'existe, renvoie une QCoapOption non valide dont la valeur est vide.
QCoapOption QCoapMessage::optionAt(int index) const
Renvoie l'option située à la position index.
int QCoapMessage::optionCount() const
Renvoie le nombre d'options.
const QList<QCoapOption> &QCoapMessage::options() const
Renvoie la liste des options.
Voir aussi setOptions().
QList<QCoapOption> QCoapMessage::options(QCoapOption::OptionName name) const
Recherche et renvoie la liste des options associées à l'name.
QByteArray QCoapMessage::payload() const
Renvoie la charge utile.
Voir aussi setPayload().
void QCoapMessage::removeOption(QCoapOption::OptionName name)
Supprime toutes les options dont l’ name est celle indiquée. Le protocole CoAP autorise la répétition d’une même option.
void QCoapMessage::removeOption(const QCoapOption &option)
Supprime l'option on indiquée.
void QCoapMessage::setMessageId(quint16 id)
Définit l'ID du message sur id.
Voir également messageId().
void QCoapMessage::setOptions(const QList<QCoapOption> &options)
Définit les options de message sur « options ».
Voir aussi options().
void QCoapMessage::setPayload(const QByteArray &payload)
Définit le contenu du message sur payload. Le contenu peut être représenté dans l'un des formats définis dans le registre des formats de contenu CoAP.
Remarque : CoAP prend en charge les formats de contenu courants tels que XML, JSON, etc., mais ceux-ci sont basés sur du texte et sont donc lourds tant au niveau de la charge utile que du traitement. L’un des formats de contenu recommandés pour CoAP est CBOR, qui est conçu pour être utilisé dans ce type de contexte.
Voir également payload(), QCborStreamWriter et QCborStreamReader.
void QCoapMessage::setToken(const QByteArray &token)
Définit le jeton de message sur token.
Voir également token().
void QCoapMessage::setType(const QCoapMessage::Type &type)
Définit le type de message sur « type ».
Voir également type().
void QCoapMessage::setVersion(quint8 version)
Définit la version CoAP sur version.
Voir également version().
[noexcept] void QCoapMessage::swap(QCoapMessage &other)
Échange ce message avec other. Cette opération est très rapide et ne rate jamais.
QByteArray QCoapMessage::token() const
Renvoie le jeton du message.
Voir également la fonction ` setToken()`.
quint8 QCoapMessage::tokenLength() const
Renvoie la longueur du jeton.
QCoapMessage::Type QCoapMessage::type() const
Renvoie le type du message.
Voir aussi setType().
quint8 QCoapMessage::version() const
Renvoie la version CoAP.
Voir aussi setVersion().
[noexcept] QCoapMessage &QCoapMessage::operator=(QCoapMessage &&other)
Déplace ` other ` dans ce message et renvoie une référence à ` QCoapMessage`.
QCoapMessage &QCoapMessage::operator=(const QCoapMessage &other)
Copie le contenu de other dans ce message. Renvoie une référence à cette adresse QCoapMessage.
© 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.
