nl::Weave::Profiles::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

ฟังก์ชันสาธารณะ

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

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

รายละเอียด
พารามิเตอร์
[out] apCommandType
ตัวชี้ไปยังตัวแปรบางตัวเพื่อรับรหัสประเภทคำสั่งที่สำเร็จ
ผลลัพธ์
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
สำเร็จแล้ว