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