nl::Weave::Profiles::DataManagement_Current::CustomCommand::Builder

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

WDM 自訂 Command 編碼器定義。

摘要

引數和驗證器元素沒有固定的結構定義，因此不直接支援。

繼承

沿用自： 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)
初始化 CustomCommand::Builder 以寫入 TLV 串流。
InitiationTimeMicroSecond(const int64_t aInitiationTimeMicroSecond)
將初始化時間插入 TLV 串流。
MustBeVersion(const uint64_t aMustBeVersion)
將必要版本插入 TLV 串流。

公用函式

ActionTimeMicroSecond

CustomCommand::Builder & ActionTimeMicroSecond(
  const int64_t aActionTimeMicroSecond
)

將動作時間插入 TLV 串流。

詳細說明
參數
[in] aActionTimeMicroSecond
這個指令的動作時間，以微秒為單位 (自 UNIX Epoch 紀元時間起算)
傳回
*這項參考資料

CommandType

CustomCommand::Builder & CommandType(
  const uint64_t aCommandType
)

將指令類型 ID 插入 TLV 串流。

詳細說明
參數
[in] aCommandType
這個指令的指令類型 ID
傳回
*這項參考資料

CreatePathBuilder

Path::Builder & CreatePathBuilder(
  void
)

初始化用於寫入 TLV 串流的 Path::Builder。

詳細說明
傳回
Path::Builder 的參考資料

EndOfCustomCommand

CustomCommand::Builder & EndOfCustomCommand(
  void
)

並標示這個指令的結尾。

詳細說明
傳回
*這項參考資料

ExpiryTimeMicroSecond

CustomCommand::Builder & ExpiryTimeMicroSecond(
  const int64_t aExpiryTimeMicroSecond
)

在 TLV 串流中插入到期時間。

詳細說明
參數
[in] aExpiryTimeMicroSecond
這個指令的到期時間，以微秒為單位 (自 UNIX Epoch 紀元時間起算)
傳回
*這項參考資料

Init

WEAVE_ERROR Init(
  nl::Weave::TLV::TLVWriter *const apWriter
)

初始化 CustomCommand::Builder 以寫入 TLV 串流。

詳細說明
參數
[in] apWriter
指向 TLVWriter 的指標
傳回值
WEAVE_NO_ERROR
成效良好

InitiationTimeMicroSecond

CustomCommand::Builder & InitiationTimeMicroSecond(
  const int64_t aInitiationTimeMicroSecond
)

將初始化時間插入 TLV 串流。

詳細說明
參數
[in] aInitiationTimeMicroSecond
這個指令的執行時間 (以微秒為單位，自 UNIX Epoch 紀元時間起算)
傳回
*這項參考資料

MustBeVersion

CustomCommand::Builder & MustBeVersion(
  const uint64_t aMustBeVersion
)

將必要版本插入 TLV 串流。

詳細說明
參數
[in] aMustBeVersion
路徑中的 Trait 執行個體必須是這個版本，系統才能接受這個指令
傳回
*這項參考資料