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 初始化剖析器物件。

公用函式

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
用來在成功時接收 Command 啟動時間的指標指標
傳回值
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
成效良好