The QCoapMessage class holds information about a CoAP message that can be a request or a reply. More...
Header: | #include <QCoapMessage> |
qmake: | QT += coap |
Inherited By: |
Note: All functions in this class are reentrant.
enum class | Type { Confirmable, NonConfirmable, Acknowledgment, Reset } |
QCoapMessage(const QCoapMessage &other) | |
QCoapMessage() | |
QCoapMessage & | operator=(QCoapMessage &&other) |
QCoapMessage & | operator=(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(const QCoapOption &option) |
void | removeOption(QCoapOption::OptionName name) |
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 |
It holds information such as the message type, message id, token and other ancillary data.
See also QCoapOption, QCoapReply, and QCoapRequest.
Indicates the type of the message.
Constant | Value | Description |
---|---|---|
QCoapMessage::Type::Confirmable |
0 |
A Confirmable message. The destination endpoint needs to acknowledge the message. |
QCoapMessage::Type::NonConfirmable |
1 |
A Non-Confirmable message. The destination endpoint does not need to acknowledge the message. |
QCoapMessage::Type::Acknowledgment |
2 |
An Acknowledgment message. A message sent or received in reply to a Confirmable message. |
QCoapMessage::Type::Reset |
3 |
A Reset message. This message type is used in case of errors or to stop the ongoing transmission. (For example, it is used to cancel an observation). |
Constructs a shallow copy of other.
Constructs a new QCoapMessage.
Move-assignment operator.
Copies the contents of other into this message. Returns a reference to this QCoapMessage.
Destroys the QCoapMessage.
Adds the given CoAP option.
This is an overloaded function.
Adds the CoAP option with the given name and value.
Removes all options.
Returns true
if the message contains at last one option with name.
Returns the message id.
See also setMessageId().
Finds and returns the first option with the given name. If there is no such option, returns an invalid QCoapOption with an empty value.
Returns the option at index position.
Returns the number of options.
Returns the list of options.
See also setOptions().
Finds and returns the list of options with the given name.
Returns the payload.
See also setPayload().
Removes the given option.
Removes all options with the given name. The CoAP protocol allows for the same option to repeat.
Sets the message ID to id.
See also messageId().
Sets the message options to options.
See also options().
Sets the message payload to payload. The payload can be represented in one of the content formats defined in CoAP Content-Formats Registry.
Note: CoAP supports common content formats such as XML, JSON, and so on, but these are text based and consequently heavy both in payload and in processing. One of the recommended content formats to use with CoAP is CBOR, which is designed to be used in such contexts.
See also payload(), QCborStreamWriter, and QCborStreamReader.
Sets the message token to token.
See also token().
Sets the message type to type.
See also type().
Sets the CoAP version to version.
See also version().
Swaps this message with other. This operation is very fast and never fails.
Returns the message token.
See also setToken().
Returns the token length.
Returns the message type.
See also setType().
Returns the CoAP version.
See also setVersion().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qcoapmessage.html