PySide6.QtCoap.QCoapMessage

class QCoapMessage

QCoapMessage 类保存了关于 CoAP 消息的信息，该消息可以是请求或回复。更多…

继承者： QCoapRequest

概要

方法

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述

它保存了诸如消息类型、消息ID、令牌和其他辅助数据的信息。

class Type

指示消息的类型。

常量

描述

QCoapMessage.Type.Confirmable

一个可确认的消息。目标端点需要确认该消息。

QCoapMessage.Type.NonConfirmable

一个非确认消息。目标端点不需要确认该消息。

QCoapMessage.Type.Acknowledgment

确认消息。作为对可确认消息的回复发送或接收的消息。

QCoapMessage.Type.Reset

重置消息。此消息类型用于错误情况或停止正在进行的传输。（例如，用于取消观察）。
__init__()

构造一个新的 QCoapMessage 。

__init__(other)
Parameters:

其他 – QCoapMessage

构造other的浅拷贝。

addOption(option)
Parameters:

选项 – QCoapOption

添加给定的CoAP option。

addOption(name[, value=QByteArray()])
Parameters:

这是一个重载函数。

添加具有给定name和value的CoAP选项。

clearOptions()

移除所有选项。

hasOption(name)
Parameters:

名称 – OptionName

Return type:

布尔

如果消息包含至少一个具有name的选项，则返回true。

messageId()
Return type:

整数

返回消息ID。

另请参阅

setMessageId()

option(name)
Parameters:

名称 – OptionName

Return type:

QCoapOption

查找并返回第一个具有给定name的选项。如果没有这样的选项，则返回一个无效的QCoapOption，其值为空。

optionAt(index)
Parameters:

索引 – int

Return type:

QCoapOption

返回位于index位置的选项。

optionCount()
Return type:

整数

返回选项的数量。

options()
Return type:

QCoapOption的列表

返回选项列表。

另请参阅

setOptions()

options(name)
Parameters:

名称 – OptionName

Return type:

QCoapOption的列表

查找并返回具有给定name的选项列表。

payload()
Return type:

QByteArray

返回有效载荷。

另请参阅

setPayload()

removeOption(name)
Parameters:

名称 – OptionName

移除所有具有给定name的选项。CoAP协议允许相同的选项重复。

removeOption(option)
Parameters:

选项 – QCoapOption

移除给定的 option。

setMessageId(id)
Parameters:

id – int

将消息ID设置为id。

另请参阅

messageId()

setOptions(options)
Parameters:

options – QCoapOption 的列表

将消息选项设置为 options。

另请参阅

options()

setPayload(payload)
Parameters:

payload – QByteArray

将消息有效负载设置为payload。有效负载可以用CoAP内容格式注册表中定义的一种内容格式表示。

注意

CoAP支持常见的内容格式，如XML、JSON等，但这些是基于文本的，因此在有效载荷和处理上都较为繁重。推荐与CoAP一起使用的内容格式之一是CBOR，它是为这种上下文设计的。

另请参阅

payload() QCborStreamWriterQCborStreamReader

setToken(token)
Parameters:

token – QByteArray

将消息令牌设置为 token。

另请参阅

token()

setType(type)
Parameters:

类型 – Type

将消息类型设置为 type。

另请参阅

type()

setVersion(version)
Parameters:

版本 – int

设置CoAP版本为version。

另请参阅

version()

swap(other)
Parameters:

其他 – QCoapMessage

将此消息与 other 交换。此操作非常快速且永远不会失败。

token()
Return type:

QByteArray

返回消息令牌。

另请参阅

setToken()

tokenLength()
Return type:

整数

返回令牌长度。

type()
Return type:

类型

返回消息类型。

另请参阅

setType()

version()
Return type:

整数

返回CoAP版本。

另请参阅

setVersion()