nl::Weave::TLV::Utilities

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

סיכום

Typedefs

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

Typedefs

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