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
成功時にコマンド開始時間を受け取る変数へのポインタ
戻り値
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
成功