透過集合功能整理內容 你可以依據偏好儲存及分類內容。

nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser

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

WDM 自訂 Command 要求剖析器定義。

總結

繼承

沿用來源: 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 初始化剖析器物件。

公開函式

檢查結構定義有效性

WEAVE_ERROR CheckSchemaValidity(
  void
) const 

確認郵件格式是否正確。

詳細資料
傳回值
WEAVE_NO_ERROR
成功

取得動作時間微秒

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const 

取得這個指令的預定動作時間。

詳細資料
參數
[out] apActionTimeMicroSecond
指向特定變數的資料點,以在成功時接收「指令」動作時間
傳回值
WEAVE_NO_ERROR
成功
WEAVE_END_OF_TLV
如果沒有這類元素
WEAVE_ERROR_WRONG_TLV_TYPE
這類元素有未簽署的整數

GetCommand 類型

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
這類元素有未簽署的整數

取得啟動時間 (微秒)

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
是否包含這類元素,但該元素並非路徑

取得 ReaderOnArgument

WEAVE_ERROR GetReaderOnArgument(
  nl::Weave::TLV::TLVReader *const apReader
) const 

初始化 TLVreader,以指向此指令中的引數元件開頭。

詳細資料
參數
[out] apReader
TLVreader 的指標,會在成功時以引數 TLV 元素進行初始化
傳回值
WEAVE_NO_ERROR
成功

取得 ReaderOnPath

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