nl::Weave::Profiles::DataManagement_Current::CustomCommand::Builder

#include <src/lib/profiles/data-management/Current/MessageDef.h>

WDM 自定义命令编码器定义。

摘要

参数和身份验证器元素不受直接支持,因为它们没有固定的架构。

继承

沿用自: nl::Weave::Profiles::DataManagement_Current::BuilderBase

公共函数

ActionTimeMicroSecond(const int64_t aActionTimeMicroSecond)
将操作时间注入 TLV 流中。
CommandType(const uint64_t aCommandType)
将命令类型 ID 注入 TLV 流中。
CreatePathBuilder(void)
初始化 Path::Builder 以写入 TLV 流。
EndOfCustomCommand(void)
标记此命令的结尾。
ExpiryTimeMicroSecond(const int64_t aExpiryTimeMicroSecond)
将过期时间注入 TLV 流中。
Init(nl::Weave::TLV::TLVWriter *const apWriter)
初始化 CustomCommand::Builder,以便写入 TLV 流。
InitiationTimeMicroSecond(const int64_t aInitiationTimeMicroSecond)
将初始化时间注入 TLV 流。
MustBeVersion(const uint64_t aMustBeVersion)
将必须是版本注入到 TLV 视频流中。

公共函数

ActionTimeMicroSecond

CustomCommand::Builder & ActionTimeMicroSecond(
  const int64_t aActionTimeMicroSecond
)

将操作时间注入 TLV 视频流。

详细信息
参数
[in] aActionTimeMicroSecond
此命令的操作时间(自 UNIX 纪元开始算起,以微秒为单位)
返回值
对 *this 的引用

CommandType

CustomCommand::Builder & CommandType(
  const uint64_t aCommandType
)

将命令类型 ID 注入 TLV 流中。

详细信息
参数
[in] aCommandType
此命令的命令类型 ID
返回值
对 *this 的引用

CreatePathBuilder

Path::Builder & CreatePathBuilder(
  void
)

初始化 Path::Builder,以写入 TLV 流。

详细信息
返回值
Path::Builder 的引用

EndOfCustomCommand

CustomCommand::Builder & EndOfCustomCommand(
  void
)

标记此命令的结尾。

详细信息
返回值
对 *this 的引用

ExpiryTimeMicroSecond

CustomCommand::Builder & ExpiryTimeMicroSecond(
  const int64_t aExpiryTimeMicroSecond
)

将到期时间插入到 TLV 视频流。

详细信息
参数
[in] aExpiryTimeMicroSecond
此命令的到期时间(与 UNIX 纪元之间相隔的微秒数)
返回值
对 *this 的引用

Init

WEAVE_ERROR Init(
  nl::Weave::TLV::TLVWriter *const apWriter
)

初始化 CustomCommand::Builder,以便写入 TLV 流。

详细信息
参数
[in] apWriter
指向 TLVWriter 的指针
返回值
WEAVE_NO_ERROR
成功时

InitiationTimeMicroSecond

CustomCommand::Builder & InitiationTimeMicroSecond(
  const int64_t aInitiationTimeMicroSecond
)

将初始化时间注入 TLV 流中。

详细信息
参数
[in] aInitiationTimeMicroSecond
此命令的初始化时间(以微秒为单位,从 UNIX 纪元开始计算)
返回值
对 *this 的引用

MustBeVersion

CustomCommand::Builder & MustBeVersion(
  const uint64_t aMustBeVersion
)

将必需的版本注入 TLV 流中。

详细信息
参数
[in] aMustBeVersion
路径中的特征实例必须为此版本,此命令才能被接受
返回值
对 *this 的引用