nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser

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

הגדרת מנתח הבקשה של Command בהתאמה אישית של WDM.

סיכום

ירושה

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

הפעלה

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

צריך לאתחל את אובייקט המנתח באמצעות TLVReader.

פרטים
פרמטרים
[in] aReader
הפניה ל-TLVReader, שצריך להצביע על תחילת הבקשה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה