nl::Weave::TLV::Utilities

وتشمل مساحة الاسم هذه أنواعًا وواجهات تطبيقات للمساعدة في إدارة TLV Weave والعمل معه.

ملخّص

تحديدات النوع
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
يشير هذا المصطلح إلى مؤشر للسياق الخاص بالمعالج، وهو مؤشر لتخزين قيمة العدد.
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح
WEAVE_ERROR_INVALID_ARGUMENT
إذا كانت قيمة aContext فارغة.

بحث

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
قيمة منطقية تشير إلى ما إذا كان (صحيح) أم لا (خطأ) أي صفائف أو بنى تمت مواجهتها يجب النزول إليها.
قيم الإرجاع
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
مؤشر يشير إلى السياق الخاص بالمعالج.
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح
WEAVE_ERROR_INVALID_ARGUMENT
إذا كانت قيمة aContext فارغة.
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
استدعاء لاستدعاء عنصر 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
استدعاء لاستدعاء عنصر TLV الحالي الذي تتم زيارته.
[in,out] aContext
مؤشر اختياري لبيانات السياق التي يقدِّمها المتصل.
قيم الإرجاع
WEAVE_END_OF_TLV
في التكرار الناجح إلى نهاية ترميز TLV، أو إلى نهاية حاوية TLV.
WEAVE_ERROR_INVALID_ARGUMENT
إذا كانت قيمة aHandler فارغة.
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
استدعاء لاستدعاء عنصر TLV الحالي الذي تتم زيارته.
[in,out] aContext
مؤشر اختياري لبيانات السياق التي يقدِّمها المتصل.
[in] aRecurse
قيمة منطقية تشير إلى ما إذا كان (true) أم لا (false) أي صفائف أو بنى تمت مواجهتها يجب النَسب إليها.
قيم الإرجاع
WEAVE_END_OF_TLV
في التكرار الناجح إلى نهاية ترميز TLV، أو إلى نهاية حاوية TLV.
WEAVE_ERROR_INVALID_ARGUMENT
إذا كانت قيمة aHandler فارغة.
The
آخر قيمة تعرضها aHandler، إذا كانت مختلفة عن WEAVE_NO_ERROR