QCoapMessage类
QCoapMessage类包含有关CoAP消息的信息,这些消息可以是请求或答复。更多信息...
头部 | #include <QCoapMessage> |
CMake | find_package(Qt6 REQUIRED COMPONENTS Coap) target_link_libraries(mytarget PRIVATE Qt6::Coap) |
qmake | QT += coap |
继承自 |
注意:此类中所有函数都是可重入的。
公共类型
枚举类 | Type { 可确认的, 不可确认的, 确认, 重置 } |
公共函数
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(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 |
QCoapMessage & | operator=(const QCoapMessage &other) |
QCoapMessage & | operator=(QCoapMessage && other) |
另请参阅 QCoapOption、QCoapReply、和 QCoapRequest。
成员类型文档
enum class QCoapMessage::Type
指示消息的类型。
常量 | 值 | 描述 |
---|---|---|
QCoapMessage::Type::Confirmable | 0 | 一个确认消息。目标端点需要确认消息。 |
QCoapMessage::Type::NonConfirmable | 1 | 一个非确认消息。目标端点不需要确认消息。 |
QCoapMessage::Type::Acknowledgment | 2 | 一个确认消息。用于回复确认消息发送或接收的消息。 |
QCoapMessage::Type::Reset | 3 | 一个重置消息。此消息类型用于错误情况或停止正在进行传输。 (例如,用于取消观察)。 |
成员函数文档
QCoapMessage::QCoapMessage()
构建一个新的QCoapMessage。
QCoapMessage::QCoapMessage(const QCoapMessage & other)
构建other的浅拷贝。
[noexcept]
QCoapMessage::~QCoapMessage()
销毁QCoapMessage。
void QCoapMessage::addOption(const QCoapOption & option)
添加给定的CoAP option。
void QCoapMessage::addOption(QCoapOption::OptionName name, const QByteArray & value = QByteArray())
这是重载函数。
添加具有给定name和value的CoAP选项。
void QCoapMessage::clearOptions()
删除所有选项。
QCoapOption::OptionName QCoapMessage::hasOption(int name) const
如果消息包含至少一个有name的选项,则返回true
。
quint16 QCoapMessage::messageId() const
返回消息ID。
另请参阅 setMessageId。
QCoapOption QCoapMessage::option(QCoapOption::OptionName name) const
查找并返回第一个具有给定name的选项。如果没有这样的选项,返回一个无效的具有空值的QCoapOption。
QCoapOption QCoapMessage::optionAt(int index) const
返回第index位置的选项。
int QCoapMessage::optionCount() const
返回选项数量。
const QList<QCoapOption> &QCoapMessage::options() const
返回选项列表。
另请参阅setOptions。
QList<QCoapOption> QCoapMessage::options(QCoapOption::OptionName name) const
查找并返回具有给定 name 的选项列表。
QByteArray QCoapMessage::payload() const
返回有效载荷。
另请参阅setPayload。
void QCoapMessage::removeOption(const QCoapOption &option)
删除指定的 option。
void QCoapMessage::removeOption(QCoapOption::OptionName name)
删除所有具有给定 name 的选项。CoAP 协议允许相同的选项重复。
void QCoapMessage::setMessageId(quint16 id)
将消息 ID 设置为 id。
另请参阅messageId。
void QCoapMessage::setOptions(const QList<QCoapOption> &options)
将消息选项设置为 options。
另请参阅options。
void QCoapMessage::setPayload(const QByteArray &payload)
将消息有效载荷设置为 payload。有效载荷可以表示为 CoAP 内容格式注册表 中定义的任何一种内容格式。
注意:CoAP 支持常见的格式,如 XML、JSON 等,但这些基于文本,因此有效载荷和处理都非常费资源。与 CoAP 一起推荐使用的一种内容格式是 CBOR,它就是为了在这样环境中使用而设计的。
另请参阅payload(),QCborStreamWriter 和 QCborStreamReader。
void QCoapMessage::setToken(const QByteArray &token)
将消息令牌设置为 token。
另请参阅token。
void QCoapMessage::setType(const QCoapMessage::Type &type)
将消息类型设置为 type。
另请参阅type。
void QCoapMessage::setVersion(quint8 version)
设置 CoAP 版本为 version。
另请参阅 version。
[noexcept]
void QCoapMessage::swap(QCoapMessage &other)
与 other 交换此消息。此操作非常快且永远不会失败。
QByteArray QCoapMessage::token() const
返回消息令牌。
另请参阅 setToken。
quint8 QCoapMessage::tokenLength() const
返回令牌长度。
QCoapMessage::Type QCoapMessage::type() const
返回消息类型。
另请参阅 setType。
quint8 QCoapMessage::version() const
返回 CoAP 版本。
另请参阅 setVersion。
QCoapMessage &QCoapMessage::operator=(const QCoapMessage &other)
将 other 的内容复制到此消息中。返回对此 QCoapMessage 的引用。
[noexcept]
QCoapMessage &QCoapMessage::operator=(QCoapMessage &&other)
移动赋值运算符。
© 2024 Qt 公司。本文件中的文档贡献享有各自所有者的版权。本文件中的文档受 GNU 自由文档许可证 1.3 版 许可,由自由软件基金会发布。Qt 及相关标志是芬兰和/或世界其他地区的 Qt 公司的商标。所有其他商标均为其各自所有者的财产。