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)
初始化 Path::Builder,以便將資料寫入 TLV 串流。
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 紀元時間開始算起)
傳回
參考資料*

CommandType

CustomCommand::Builder & CommandType(
  const uint64_t aCommandType
)

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

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

CreatePathBuilder

Path::Builder & CreatePathBuilder(
  void
)

初始化 Path::Builder,以便將內容寫入 TLV 串流。

詳細資料
傳回
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
)

初始化 CustomCommand::Builder,以便將資料寫入 TLV 串流。

詳細資料
參數
[in] apWriter
指向 TLVWriter 的指標
傳回值
WEAVE_NO_ERROR
成功時

InitiationTimeMicroSecond

CustomCommand::Builder & InitiationTimeMicroSecond(
  const int64_t aInitiationTimeMicroSecond
)

將啟動時間插入 TLV 串流。

詳細資料
參數
[in] aInitiationTimeMicroSecond
這個指令的初始化時間,以自 UNIX 紀元時間起算的微秒為單位
傳回
參考資料*

MustBeVersion

CustomCommand::Builder & MustBeVersion(
  const uint64_t aMustBeVersion
)

將必需版本插入 TLV 串流。

詳細資料
參數
[in] aMustBeVersion
路徑中的 Trait 執行個體必須屬於這個版本,才能接受這項指令
傳回
*this 的參照