nl::Weave::TLV::Utilities

מרחב השמות הזה כולל סוגים וממשקי עזר לניהול ולעבודה עם Weave TLV.

סיכום

ערכי דף

IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext) typedef

פונקציות

Count(const TLVReader & aReader, size_t & aCount)
לספור את מספר רכיבי ה-TLV בקורא ה-TLV שצוין, בסדר יורד למערכים או למבנים.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
לספור את מספר רכיבי ה-TLV בקורא ה-TLV שצוין, בסדר יורד, למערכים או למבנים.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
להגדיל את המונה כשחוזרים על הנתונים של TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
מחפשים את התג שצוין בקורא TLV שסופק.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
מחפשים את התג שצוין בקורא ה-TLV שסופק, ויש אפשרות בסדר יורד אל מערכים או מבנים.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
מחפשים את הרכיב הראשון שתואם לפרדיקאט בקורא TLV בסדר יורד, למערכים או למבנים.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
מחפשים את הרכיב הראשון שתואם לפרדיקאט בקורא TLV, אם רוצים, בסדר יורד למערכים או למבנים.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
מחפשים את התג שצוין בקורא TLV שסופק.
FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
מבצעים איטרציה בנתוני TLV ש-aReader מפנה אליהם, ומפעילים aHandler לכל רכיב TLV שבו ביקרת בהקשר של aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
מבצעים איטרציה בנתוני TLV ש-aReader מפנה אליהם, ומפעילים aHandler לכל רכיב TLV שבו ביקרת בהקשר של aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
מבצעים איטרציה בנתוני TLV ש-aReader מפנה אליהם, ומפעילים aHandler לכל רכיב TLV שבו ביקרת בהקשר של aContext.

מבנים

nl::Weave::TLV::Utilities::FindContext
nl::Weave::TLV::Utilities::FindPredicateContext

ערכי דף

IterateHandler

WEAVE_ERROR(* IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext)

פונקציות

מספר פעמים

WEAVE_ERROR Count(
  const TLVReader & aReader,
  size_t & aCount
)

לספור את מספר רכיבי ה-TLV בקורא ה-TLV שצוין, בסדר יורד למערכים או למבנים.

פרטים
פרמטרים
[in] aReader
הפניה לקריאה בלבד לקורא TLV שעבורו יש לספור את מספר רכיבי TLV.
[in,out] aCount
הפניה לאחסון עבור הספירה שהוחזרה. הערך הזה מאותחל לאפס (0) לפני הספירה, ומוגדר למספר הרכיבים שנספרו בהצלחה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.

מספר פעמים

WEAVE_ERROR Count(
  const TLVReader & aReader,
  size_t & aCount,
  const bool aRecurse
)

לספור את מספר רכיבי ה-TLV בקורא ה-TLV שצוין, בסדר יורד, למערכים או למבנים.

פרטים
פרמטרים
[in] aReader
הפניה לקריאה בלבד לקורא TLV שעבורו יש לספור את מספר רכיבי TLV.
[in,out] aCount
הפניה לאחסון עבור הספירה שהוחזרה. הערך הזה מאותחל לאפס (0) לפני הספירה, ומוגדר למספר הרכיבים שנספרו בהצלחה.
[in] aRecurse
ערך בוליאני שמציין אם (true) או לא (false) יש לרדת לתוכו מערכים או מבנים שנמצאו.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.

CountHandler

WEAVE_ERROR CountHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

להגדיל את המונה כשחוזרים על הנתונים של TLV.

פרטים
פרמטרים
[in] aReader
הפניה לקורא TLV שמכיל את נתוני TLV לספירת מספר רכיבי TLV.
[in] aDepth
העומק הנוכחי של נתוני TLV.
[in,out] aContext
הפניה להקשר הספציפי של ה-handler, שהוא המצביע לאחסון של ערך הספירה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
WEAVE_ERROR_INVALID_ARGUMENT
אם aContext הוא NULL.

חיפוש

WEAVE_ERROR Find(
  const TLVReader & aReader,
  const uint64_t & aTag,
  TLVReader & aResult
)

מחפשים את התג שצוין בקורא TLV שסופק.

פרטים
פרמטרים
[in] aReader
הפניה לקריאה בלבד לקורא TLV שבה יש למצוא את התג שצוין.
[in] aTag
הפניה לקריאה בלבד לתג TLV שאפשר למצוא.
[out] aResult
הפניה לאחסון לקורא TLV שתמוקם בתג שצוין כשתתבצע בהצלחה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
אם התג שצוין aTag לא נמצא.

חיפוש

WEAVE_ERROR Find(
  const TLVReader & aReader,
  const uint64_t & aTag,
  TLVReader & aResult,
  const bool aRecurse
)

מחפשים את התג שצוין בקורא ה-TLV שסופק, ויש אפשרות בסדר יורד אל מערכים או מבנים.

פרטים
פרמטרים
[in] aReader
הפניה לקריאה בלבד לקורא TLV שבה יש למצוא את התג שצוין.
[in] aTag
הפניה לקריאה בלבד לתג TLV שאפשר למצוא.
[out] aResult
הפניה לאחסון לקורא TLV שתמוקם בתג שצוין כשתתבצע בהצלחה.
[in] aRecurse
ערך בוליאני שמציין אם (true) או לא (false) יש לרדת לתוכו מערכים או מבנים שנמצאו.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
אם התג שצוין aTag לא נמצא.

חיפוש

WEAVE_ERROR Find(
  const TLVReader & aReader,
  IterateHandler aPredicate,
  void *aContext,
  TLVReader & aResult
)

מחפשים את הרכיב הראשון שתואם לפרדיקאט בקורא TLV בסדר יורד, למערכים או למבנים.

ה-aPredicate יחול על כל רכיב TLV שבו ביקרת; הפרמטר aPredicate יחזיר WEAVE_ERROR_MAX עבור הרכיבים התואמים, WEAVE_NO_ERROR עבור רכיבים לא תואמים, וכל ערך אחר לסיום החיפוש.

פרטים
פרמטרים
[in] aReader
הפניה לקריאה בלבד לקורא TLV שבה יש למצוא את הרכיב שתואם לפרדיקאט.
[in] aPredicate
ייחוס שיחול על כל רכיב TLV. כדי לתמוך בשימוש חוזר בקוד, APredicate כולל את הסוג IterateHandler. הערך המוחזר של aPredicate שולט בחיפוש: WEAVE_ERROR_MAX מאותתת שהרכיב הרצוי נמצא, WEAVE_NO_ERROR מצביע על כך שהרכיב הרצוי לא נמצא, וכל הערכים האחרים מצביעים על כך שיש לסיים את ה-saerch.
[in] aContext
מצביע אופציונלי לנתוני הקשר שסיפק המתקשר.
[out] aResult
הפניה לאחסון לקורא TLV שתמוקם בתג שצוין כשתתבצע בהצלחה.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
אם ה-aPredicate שצוין לא מאתר את הרכיב שצוין

חיפוש

WEAVE_ERROR Find(
  const TLVReader & aReader,
  IterateHandler aPredicate,
  void *aContext,
  TLVReader & aResult,
  const bool aRecurse
)

מחפשים את הרכיב הראשון שתואם לפרדיקאט בקורא TLV, אם רוצים, בסדר יורד למערכים או למבנים.

ה-aPredicate יחול על כל רכיב TLV שבו ביקרת; הפרמטר aPredicate יחזיר WEAVE_ERROR_MAX עבור הרכיבים התואמים, WEAVE_NO_ERROR עבור רכיבים לא תואמים, וכל ערך אחר לסיום החיפוש.

פרטים
פרמטרים
[in] aReader
הפניה לקריאה בלבד לקורא TLV שבה יש למצוא את הרכיב שתואם לפרדיקאט.
[in] aPredicate
ייחוס שיחול על כל רכיב TLV. סוג השינוי של aPredicate הוא IterateHandler, כדי לתמוך בשימוש חוזר בקוד. הערך המוחזר של aPredicate שולט בחיפוש: WEAVE_ERROR_MAX מאותתת שהרכיב הרצוי נמצא, WEAVE_NO_ERROR מצביע על כך שהרכיב הרצוי לא נמצא, וכל הערכים האחרים מצביעים על כך שיש לסיים את ה-saerch.
[in] aContext
מצביע אופציונלי לנתוני הקשר שסיפק המתקשר.
[out] aResult
הפניה לאחסון לקורא TLV שתמוקם בתג שצוין כשתתבצע בהצלחה.
[in] aRecurse
ערך בוליאני שמציין אם (true) או לא (false) יש לרדת לתוכו מערכים או מבנים שנמצאו.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
אם ה-aPredicate שצוין לא מאתר את הרכיב שצוין

FindHandler

WEAVE_ERROR FindHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

מחפשים את התג שצוין בקורא TLV שסופק.

פרטים
פרמטרים
[in] aReader
הפניה לקריאה בלבד לקורא TLV שבה יש למצוא את התג שצוין.
[in] aDepth
העומק הנוכחי של נתוני TLV.
[in,out] aContext
הפניה להקשר הספציפי של ה-handler.
ערכים מוחזרים
WEAVE_NO_ERROR
בהצלחה.
WEAVE_ERROR_INVALID_ARGUMENT
אם aContext הוא NULL.
WEAVE_ERROR_MAX
אם התג שצוין נמצא.

FindPredicateHandler

WEAVE_ERROR FindPredicateHandler(
  const TLVReader & aReader,
  size_t aDepth,
  void *aContext
)

מעבר חוזר

WEAVE_ERROR Iterate(
  TLVReader & aReader,
  size_t aDepth,
  IterateHandler aHandler,
  void *aContext,
  bool aRecurse
)

מבצעים איטרציה בנתוני TLV ש-aReader מפנה אליהם, ומפעילים aHandler לכל רכיב TLV שבו ביקרת בהקשר של aContext.

האיטרציה מתבטלת אם aHandler מחזיר משהו שאינו WEAVE_NO_ERROR

פרטים
פרמטרים
[in] aReader
הפניה לקורא TLV שמכיל את נתוני TLV לחזרה.
[in] aDepth
העומק הנוכחי של נתוני TLV.
[in] aHandler
קריאה חוזרת (callback) להפעלה לרכיב TLV הנוכחי שנבחר.
[in,out] aContext
מצביע אופציונלי לנתוני הקשר שסיפק המתקשר.
[in] aRecurse
ערך בוליאני שמציין אם (true) או לא (false) יש לרדת לתוכו מערכים או מבנים שנמצאו.
ערכים מוחזרים
WEAVE_END_OF_TLV
באיטרציה מוצלחת לסוף קידוד TLV, או לסוף של מאגר TLV.
The
הערך האחרון המוחזר על ידי aHandler, אם שונה מ-WEAVE_NO_ERROR

מעבר חוזר

WEAVE_ERROR Iterate(
  const TLVReader & aReader,
  IterateHandler aHandler,
  void *aContext
)

מבצעים איטרציה בנתוני TLV ש-aReader מפנה אליהם, ומפעילים aHandler לכל רכיב TLV שבו ביקרת בהקשר של aContext.

האיטרציה מתבטלת אם aHandler מחזיר משהו שאינו WEAVE_NO_ERROR

פרטים
פרמטרים
[in] aReader
הפניה לקורא TLV שמכיל את נתוני TLV לחזרה.
[in] aHandler
קריאה חוזרת (callback) להפעלה לרכיב TLV הנוכחי שנבחר.
[in,out] aContext
מצביע אופציונלי לנתוני הקשר שסיפק המתקשר.
ערכים מוחזרים
WEAVE_END_OF_TLV
באיטרציה מוצלחת לסוף קידוד TLV, או לסוף של מאגר TLV.
WEAVE_ERROR_INVALID_ARGUMENT
אם aHandler הוא NULL.
The
הערך האחרון המוחזר על ידי aHandler, אם שונה מ-WEAVE_NO_ERROR

מעבר חוזר

WEAVE_ERROR Iterate(
  const TLVReader & aReader,
  IterateHandler aHandler,
  void *aContext,
  const bool aRecurse
)

מבצעים איטרציה בנתוני TLV ש-aReader מפנה אליהם, ומפעילים aHandler לכל רכיב TLV שבו ביקרת בהקשר של aContext.

האיטרציה מתבטלת אם aHandler מחזיר משהו שאינו WEAVE_NO_ERROR

פרטים
פרמטרים
[in] aReader
הפניה לקורא TLV שמכיל את נתוני TLV לחזרה.
[in] aHandler
קריאה חוזרת (callback) להפעלה לרכיב TLV הנוכחי שנבחר.
[in,out] aContext
מצביע אופציונלי לנתוני הקשר שסיפק המתקשר.
[in] aRecurse
ערך בוליאני שמציין אם (true) או לא (false) יש לרדת לתוכו מערכים או מבנים שנמצאו.
ערכים מוחזרים
WEAVE_END_OF_TLV
באיטרציה מוצלחת לסוף קידוד TLV, או לסוף של מאגר TLV.
WEAVE_ERROR_INVALID_ARGUMENT
אם aHandler הוא NULL.
The
הערך האחרון המוחזר על ידי aHandler, אם שונה מ-WEAVE_NO_ERROR