nl::Weave::โปรไฟล์::DataManagement_Current::CustomCommand::Parser

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

คําจํากัดความของโปรแกรมแยกวิเคราะห์คําขอ Command ที่กําหนดเองของ WDM

สรุป

การสืบทอด

รับค่าจาก: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

ฟังก์ชันสาธารณะ
CheckSchemaValidity(void) const
ตรวจสอบว่าข้อความนั้นมีรูปแบบที่ถูกต้อง
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
รับเวลาดําเนินการที่ตั้งเวลาไว้สําหรับคําสั่งนี้
GetCommandType(uint64_t *const apCommandType) const
รับรหัสประเภทคําสั่งสําหรับคําสั่งนี้
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
สําเร็จ

GetActionTimeMicroSecond

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

รับรหัสประเภทคําสั่งสําหรับคําสั่งนี้

รายละเอียด
พารามิเตอร์
[out] apCommandType
ตัวชี้ไปยังตัวแปรบางตัวเพื่อรับรหัสประเภทคําสั่งที่สําเร็จ
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จ
WEAVE_END_OF_TLV
หากไม่มีองค์ประกอบดังกล่าว
WEAVE_ERROR_WRONG_TLV_TYPE
หากมีองค์ประกอบดังกล่าวแต่ไม่ใช่จํานวนเต็มที่ไม่มีเครื่องหมาย

รับเวลาหมดอายุแบบไมโครวินาที

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
ตัวชี้ไปยังตัวแปรบางตัวเพื่อรับเวลาเริ่มต้นของ Command สําหรับความสําเร็จ
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จ
WEAVE_END_OF_TLV
หากไม่มีองค์ประกอบดังกล่าว
WEAVE_ERROR_WRONG_TLV_TYPE
หากมีองค์ประกอบดังกล่าวแต่ไม่ใช่จํานวนเต็มที่มีเครื่องหมาย

เวอร์ชันของ GetmustBe

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

รับเวอร์ชันบังคับสําหรับคําสั่งนี้

รายละเอียด
พารามิเตอร์
[out] apMustBeVersion
ตัวชี้ไปยังตัวแปรเพื่อรับเวอร์ชันที่จําเป็นต้องทํา
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จ
WEAVE_END_OF_TLV
หากไม่มีองค์ประกอบดังกล่าว
WEAVE_ERROR_WRONG_TLV_TYPE
หากมีองค์ประกอบดังกล่าวแต่ไม่ใช่จํานวนเต็มที่ไม่มีเครื่องหมาย

เส้นทาง Get

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
หากมีองค์ประกอบดังกล่าวแต่ไม่ใช่ Path

GetReaderOnArgument

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

เริ่มต้น TLVReader เพื่อชี้ไปที่จุดเริ่มต้นของคอมโพเนนต์อาร์กิวเมนต์ในคําสั่งนี้

รายละเอียด
พารามิเตอร์
[out] apReader
ตัวชี้ไปยัง TLVReader ซึ่งจะเริ่มต้นที่องค์ประกอบอาร์กิวเมนต์ TLV สําเร็จ
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จ

GetPatherOnPath

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

เริ่มต้น TLVReader เพื่อชี้ไปที่จุดเริ่มต้นของคอมโพเนนต์เส้นทางในคําสั่งนี้

รายละเอียด
พารามิเตอร์
[out] apReader
ตัวชี้ไปยัง TLVReader ซึ่งจะเริ่มต้นที่องค์ประกอบอาร์กิวเมนต์ TLV สําเร็จ
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จ

เริ่ม

WEAVE_ERROR Init(
  const nl::Weave::TLV::TLVReader & aReader
)

เริ่มต้นออบเจ็กต์โปรแกรมแยกวิเคราะห์ด้วย TLVReader

รายละเอียด
พารามิเตอร์
[in] aReader
ตัวชี้ไปยัง TLVReader ซึ่งควรชี้ไปยังจุดเริ่มต้นของคําขอนี้
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จ