QCoapMessage Class
La classe QCoapMessage contient des informations sur un message CoAP qui peut être une demande ou une réponse. Plus d'informations...
| En-tête : | #include <QCoapMessage> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Coap)target_link_libraries(mytarget PRIVATE Qt6::Coap) |
| qmake : | QT += coap |
| Inherited By : |
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 auxiliaires.
Voir également QCoapOption, QCoapReply, et QCoapRequest.
Documentation sur les types de membres
enum class QCoapMessage::Type
Indique le type de message.
| Constante | Valeur | Description du message |
|---|---|---|
QCoapMessage::Type::Confirmable | 0 | Message confirmable. Le point d'extrémité de destination doit accuser réception du message. |
QCoapMessage::Type::NonConfirmable | 1 | Message non confirmable. Le point de destination ne doit pas accuser réception du message. |
QCoapMessage::Type::Acknowledgment | 2 | Message d'accusé de réception. Un 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 arrêter la transmission en cours. (Par exemple, il est utilisé pour annuler une observation). |
Documentation des fonctions membres
QCoapMessage::QCoapMessage()
Construit un nouveau QCoapMessage.
QCoapMessage::QCoapMessage(const QCoapMessage &other)
Construit une copie superficielle de other.
[noexcept] QCoapMessage::~QCoapMessage()
Détruit le site QCoapMessage.
void QCoapMessage::addOption(const QCoapOption &option)
Ajoute le CoAP option donné.
void QCoapMessage::addOption(QCoapOption::OptionName name, const QByteArray &value = QByteArray())
Ajoute l'option CoAP avec les données name et value.
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 avec l'adresse name donnée. S'il n'y a pas d'option de ce type, il renvoie un QCoapOption invalide avec une valeur vide.
QCoapOption QCoapMessage::optionAt(int index) const
Renvoie l'option à 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 d'options avec l'adresse name.
QByteArray QCoapMessage::payload() const
Renvoie la charge utile.
Voir aussi setPayload().
void QCoapMessage::removeOption(QCoapOption::OptionName name)
Supprime toutes les options avec l'adresse name. Le protocole CoAP permet de répéter la même option.
void QCoapMessage::removeOption(const QCoapOption &option)
Supprime l'adresse option.
void QCoapMessage::setMessageId(quint16 id)
Définit l'ID du message à id.
Voir aussi messageId().
void QCoapMessage::setOptions(const QList<QCoapOption> &options)
Définit les options du message à options.
Voir aussi options().
void QCoapMessage::setPayload(const QByteArray &payload)
Définit la charge utile du message à payload. La charge utile peut être représentée dans l'un des formats de contenu définis dans le registre des formats de contenu CoAP.
Note : 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 à la fois en termes de charge utile et de traitement. L'un des formats de contenu recommandés pour CoAP est CBOR, qui est conçu pour être utilisé dans de tels contextes.
Voir également payload(), QCborStreamWriter, et QCborStreamReader.
void QCoapMessage::setToken(const QByteArray &token)
Définit le jeton de message à token.
Voir aussi token().
void QCoapMessage::setType(const QCoapMessage::Type &type)
Définit le type de message à type.
Voir aussi type().
void QCoapMessage::setVersion(quint8 version)
Définit la version CoAP à version.
Voir aussi version().
[noexcept] void QCoapMessage::swap(QCoapMessage &other)
Remplace ce message par other. Cette opération est très rapide et n'échoue jamais.
QByteArray QCoapMessage::token() const
Renvoie le jeton de message.
Voir aussi setToken().
quint8 QCoapMessage::tokenLength() const
Renvoie la longueur du jeton.
QCoapMessage::Type QCoapMessage::type() const
Renvoie le type de 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 à ce 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.
