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)
TLV ストリームに書き込むために Path::Builder を初期化します。
EndOfCustomCommand(void)
このコマンドの終了をマークします。
ExpiryTimeMicroSecond(const int64_t aExpiryTimeMicroSecond)
有効期限を TLV ストリームに挿入します。
Init(nl::Weave::TLV::TLVWriter *const apWriter)
TLV ストリームに書き込むために CustomCommand::Builder を初期化します。
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
)

TLV ストリームに書き込むために Path::Builder を初期化します。

詳細
戻り値
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
)

TLV ストリームに書き込むために CustomCommand::Builder を初期化します。

詳細
パラメータ
[in] apWriter
TLVWriter へのポインタ
戻り値
WEAVE_NO_ERROR
成功

InitiationTimeMicroSecond

CustomCommand::Builder & InitiationTimeMicroSecond(
  const int64_t aInitiationTimeMicroSecond
)

初期化時刻を TLV ストリームに挿入します。

詳細
パラメータ
[in] aInitiationTimeMicroSecond
このコマンドの init 時間(UNIX エポックからのマイクロ秒単位)
戻り値
*this への参照。

MustBeVersion

CustomCommand::Builder & MustBeVersion(
  const uint64_t aMustBeVersion
)

必須のバージョンを TLV ストリームに挿入します。

詳細
パラメータ
[in] aMustBeVersion
このコマンドを受け入れるには、パス内のトレイト インスタンスがこのバージョンである必要があります
戻り値
*this への参照。