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
成功