nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser

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

WDM 自定义命令请求解析器定义。

摘要

继承

继承自： nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

公共函数
CheckSchemaValidity(void) const
粗略验证消息的格式是否正确。
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
获取此命令的预定操作时间。
GetCommandType(uint64_t *const apCommandType) const
获取此命令的命令类型 ID。
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
获取此命令的过期时间。
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
获取此命令的启动时间。
GetMustBeVersion(uint64_t *const apMustBeVersion) const
获取此命令的必备版本。
GetPath(Path::Parser *const apPath) const
使用此命令中的路径组成部分初始化 Path::Parser。
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
初始化 TLVReader，以指向此命令中参数组件的开头。
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
初始化 TLVReader，以指向此命令中路径组成部分的开头。
Init(const nl::Weave::TLV::TLVReader & aReader)
使用 TLVReader 初始化解析器对象。

公共函数

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

粗略验证消息的格式是否正确。

具体说明
返回值
WEAVE_NO_ERROR
成功时

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

获取此命令的预定操作时间。

具体说明
参数
[out] apActionTimeMicroSecond
指向某个变量的指针，以便在成功时接收 Command 操作时间
返回值
WEAVE_NO_ERROR
成功时
WEAVE_END_OF_TLV
（如果没有此类元素）
WEAVE_ERROR_WRONG_TLV_TYPE
如果存在此类元素，但其不是带符号的整数

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

获取此命令的命令类型 ID。

具体说明
参数
[out] apCommandType
指向某个变量的指针，以便在成功时接收命令类型 ID
返回值
WEAVE_NO_ERROR
成功时
WEAVE_END_OF_TLV
（如果没有此类元素）
WEAVE_ERROR_WRONG_TLV_TYPE
如果存在此类元素，但该元素不是无符号整数

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

获取此命令的过期时间。

具体说明
参数
[out] apExpiryTimeMicroSecond
指向某个变量的指针，以便在成功时接收过期时间
返回值
WEAVE_NO_ERROR
成功时
WEAVE_END_OF_TLV
（如果没有此类元素）
WEAVE_ERROR_WRONG_TLV_TYPE
如果存在此类元素，但其不是带符号的整数

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

获取此命令的启动时间。

具体说明
参数
[out] apInitiationTimeMicroSecond
指向某个变量的指针，以便在成功时接收 Command 启动时间
返回值
WEAVE_NO_ERROR
成功时
WEAVE_END_OF_TLV
（如果没有此类元素）
WEAVE_ERROR_WRONG_TLV_TYPE
如果存在此类元素，但其不是带符号的整数

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

获取此命令的必备版本。

具体说明
参数
[out] apMustBeVersion
指向某个变量的指针，以便在成功时接收必选版本
返回值
WEAVE_NO_ERROR
成功时
WEAVE_END_OF_TLV
（如果没有此类元素）
WEAVE_ERROR_WRONG_TLV_TYPE
如果存在此类元素，但该元素不是无符号整数

GetPath

WEAVE_ERROR GetPath(
  Path::Parser *const apPath
) const

使用此命令中的路径组成部分初始化 Path::Parser。

具体说明
参数
[out] apPath
指向 Path::Parser 的指针，它会在成功时通过嵌入的路径组件初始化
返回值
WEAVE_NO_ERROR
成功时
WEAVE_END_OF_TLV
（如果没有此类元素）
WEAVE_ERROR_WRONG_TLV_TYPE
如果存在此类元素，但该路径并非路径，则会发生该错误

GetReaderOnArgument

WEAVE_ERROR GetReaderOnArgument(
  nl::Weave::TLV::TLVReader *const apReader
) const

初始化 TLVReader，以指向此命令中参数组件的开头。

具体说明
参数
[out] apReader
指向 TLVReader 的指针，成功后将在参数 TLV 元素处初始化
返回值
WEAVE_NO_ERROR
成功时

GetReaderOnPath

WEAVE_ERROR GetReaderOnPath(
  nl::Weave::TLV::TLVReader *const apReader
) const

初始化 TLVReader，以指向此命令中路径组成部分的开头。

具体说明
参数
[out] apReader
指向 TLVReader 的指针，成功后将在参数 TLV 元素处初始化
返回值
WEAVE_NO_ERROR
成功时

Init

WEAVE_ERROR Init(
  const nl::Weave::TLV::TLVReader & aReader
)

使用 TLVReader 初始化解析器对象。

具体说明
参数
[in] aReader
指向 TLVReader 的指针，应指向此请求的开头
返回值
WEAVE_NO_ERROR
成功时