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
מצביע אל משתנה מסוים כדי לקבל את זמן הפעולה של הפקודה בסיום הפעולה
מוחזר ערכים
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
להצלחה