nl::Weave::TLV::Utilities

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

ملخّص

تعريف الأنواع
IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext) تعريف الكتابة

الدوال
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
قيمة منطقية تشير إلى ما إذا كان (صحيح) أم لا (خطأ) يجب أن تندرج فيها أي مصفوفات أو بنى تم العثور عليها.
قيم الإرجاع
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
قيمة منطقية تشير إلى ما إذا كان (صحيح) أم لا (خطأ) يجب أن تندرج فيها أي مصفوفات أو بنى تم العثور عليها.
قيم الإرجاع
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
قيمة منطقية تشير إلى ما إذا كانت (صحيح) أو لا (خطأ) يجب أن تندرج فيها أيّ صفائف أو بنية تم العثور عليها.
قيم الإرجاع
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
قيمة منطقية تشير إلى ما إذا كان (صحيح) أم لا (خطأ) يجب أن تندرج فيها أي مصفوفات أو بنى تم العثور عليها.
قيم الإرجاع
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
قيمة منطقية تشير إلى ما إذا كان (صحيح) أم لا (خطأ) يجب أن تندرج فيها أي مصفوفات أو بنى تم العثور عليها.
قيم الإرجاع
WEAVE_END_OF_TLV
عند تكرارها بنجاح إلى نهاية ترميز TLV أو إلى نهاية حاوية TLV.
WEAVE_ERROR_INVALID_ARGUMENT
إذا كانت aHandler فارغة.
The
القيمة الأخيرة التي يعرضها aHandler، إذا كانت مختلفة عن WEAVE_NO_ERROR