nl::Weave::Profiles::DataManagement_Current::UpdateRequest::Parser

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

WDM 更新请求解析器定义。

摘要

继承

沿用自： nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

公共函数
CheckSchemaValidity(void) const
粗略验证消息格式是否正确。
GetDataList(DataList::Parser *const apDataList) const
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
获取此请求的过期时间。
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
初始化 TLVReader，使其指向此请求中参数组件的开头。
GetUpdateRequestIndex(uint32_t *const apUpdateRequestIndex) const
获取此请求的 UpdateRequestIndex。
Init(const nl::Weave::TLV::TLVReader & aReader)
使用 TLVReader 初始化解析器对象。

公共函数

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

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

详细信息
返回值
WEAVE_NO_ERROR
成功时

GetDataList

WEAVE_ERROR GetDataList(
  DataList::Parser *const apDataList
) const

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

获取此请求的过期时间。

详细信息
参数
[out] apExpiryTimeMicroSecond
指向某个变量的指针，用于在成功时接收过期时间
返回值
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
成功时

GetUpdateRequestIndex

WEAVE_ERROR GetUpdateRequestIndex(
  uint32_t *const apUpdateRequestIndex
) const

获取此请求的 UpdateRequestIndex。

详细信息
参数
[out] apUpdateRequestIndex
指向某个变量的指针，用于接收负载的索引。
返回值
WEAVE_NO_ERROR
成功时
WEAVE_END_OF_TLV
如果不存在此类元素
WEAVE_ERROR_WRONG_TLV_TYPE
如果存在此类元素，但该元素不是无符号整数

Init

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

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

详细信息
参数
[in] aReader
指向 TLVReader 的指针，它应指向此请求的开头
返回值
WEAVE_NO_ERROR
成功时