nl::Weave::Profiles::BDX_Development::ReceiveAccept

#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>

当接收方是发起者时,ReceiveAccept 消息用于接受提议的交换。

摘要

继承

继承自: nl::Weave::Profiles::BDX_Development::SendAccept

构造函数和析构函数

ReceiveAccept(void)
包含发送接受消息默认值的 no-arg 构造函数。

公共属性

mDefiniteLength
bool
如果选择了明确长度,则为 true。
mLength
uint64_t
我们确定的转账时长。
mMetaData
(可选)TLV 元数据。
mWideRange
bool
如果范围和偏移量字段为 64 位,则为 True。

公共函数

init(uint8_t aVersion, uint8_t aTransferMode, uint16_t aMaxBlockSize, uint64_t aLength, ReferencedTLVData *aMetaData)
初始化“宽”接收接受帧。
init(uint8_t aVersion, uint8_t aTransferMode, uint16_t aMaxBlockSize, uint32_t aLength, ReferencedTLVData *aMetaData)
初始化“非宽”接收接受帧(32 位长度)
operator==(const ReceiveAccept &) const
bool
ReceiveAccept 消息之间的相等性比较。
pack(PacketBuffer *aBuffer)
将接收接受消息打包到 PacketBuffer 中。
packedLength(void)
uint16_t
返回此接收接受消息的打包长度。

公共静态函数

parse(PacketBuffer *aBuffer, ReceiveAccept & aResponse)
将 PacketBuffer 中的数据解析为 ReceiveAccept 消息格式。

公共属性

mDefiniteLength

bool mDefiniteLength

如果选择了明确长度,则为 true。

mLength

uint64_t mLength

我们确定的转账时长。

mMetaData

ReferencedTLVData mMetaData

(可选)TLV 元数据。

mWideRange

bool mWideRange

如果范围和偏移量字段为 64 位,则为 True。

公共函数

ReceiveAccept

 ReceiveAccept(
  void
)

包含发送接受消息默认值的 no-arg 构造函数。

init

WEAVE_ERROR init(
  uint8_t aVersion,
  uint8_t aTransferMode,
  uint16_t aMaxBlockSize,
  uint64_t aLength,
  ReferencedTLVData *aMetaData
)

初始化“宽”接收接受帧。

具体说明
参数
[in] aVersion
我们使用的 BDX 版本
[in] aTransferMode
要在传输作业中使用的传输模式
[in] aMaxBlockSize
此项传输允许的最大块大小
[in] aLength
要传输的文件的长度,如果不确定,则为 0
[in] aMetaData
(可选)TLV 元数据
返回值
WEAVE_NO_ERROR(如果成功)

init

WEAVE_ERROR init(
  uint8_t aVersion,
  uint8_t aTransferMode,
  uint16_t aMaxBlockSize,
  uint32_t aLength,
  ReferencedTLVData *aMetaData
)

初始化“非宽”接收接受帧(32 位长度)

具体说明
参数
[in] aVersion
我们使用的 BDX 版本
[in] aTransferMode
要在传输作业中使用的传输模式
[in] aMaxBlockSize
此项传输允许的最大块大小
[in] aLength
要传输的文件的长度,如果不确定,则为 0
[in] aMetaData
(可选)TLV 元数据
返回值
WEAVE_NO_ERROR(如果成功)

运算符==

bool operator==(
  const ReceiveAccept &
) const 

ReceiveAccept 消息之间的相等性比较。

具体说明
参数
[in] another
要与这条消息进行比较的另一 ReceiveAccept 消息
返回值
当且仅当它们具有相同的字段时,才返回 true。

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

将接收接受消息打包到 PacketBuffer 中。

具体说明
参数
[out] aBuffer
ReceiveAccept 消息打包到
返回值
WEAVE_NO_ERROR
如果成功
WEAVE_ERROR_BUFFER_TOO_SMALL
如果缓冲区过小

packedLength

uint16_t packedLength(
  void
)

返回此接收接受消息的打包长度。

具体说明
返回值
打包后的消息长度

公共静态函数

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  ReceiveAccept & aResponse
)

将 PacketBuffer 中的数据解析为 ReceiveAccept 消息格式。

具体说明
参数
[in] aBuffer
指向包含我们想要解析的数据的 PacketBuffer 的指针
[out] aResponse
指向 ReceiveAccept 对象的指针,我们应在其中存储结果
返回值
WEAVE_NO_ERROR
如果成功
WEAVE_ERROR_BUFFER_TOO_SMALL
如果缓冲区过小