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)
Iterate through the TLV data referenced by aReader and invoke aHandler for each visited TLV element in the context of aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Iterate through the TLV data referenced by aReader and invoke aHandler for each visited TLV element in the context of aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Iterate through the TLV data referenced by aReader and invoke aHandler for each visited TLV element in the context of 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
ارجاعی به فضای ذخیره‌سازی برای تعداد برگردانده‌شده. این مقدار قبل‌از شمارش روی صفر (۰) مقداردهی اولیه می‌شود و درصورت موفقیت، روی تعداد عناصر شمارش‌شده تنظیم می‌شود.
مقادیر برگشتی
WEAVE_NO_ERROR
درصورت موفقیت.

شمارش

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

تعداد عناصر TLV را در خواننده TLV مشخص‌شده می‌شمارد، به‌طور اختیاری به آرایه‌ها یا ساختارها نزول می‌کند.

جزئیات
پارامترها
[in] aReader
مرجع فقط خواندنی به خواننده TLV که تعداد عناصر TLV برای آن شمارش می‌شود.
[in,out] aCount
ارجاعی به فضای ذخیره‌سازی برای تعداد برگردانده‌شده. این مقدار قبل‌از شمارش روی صفر (۰) مقداردهی اولیه می‌شود و درصورت موفقیت، روی تعداد عناصر شمارش‌شده تنظیم می‌شود.
[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 مقدار 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
یک عبارت بولی که نشان می‌دهد آیا (درست) یا نه (نادرست) هر آرایه یا ساختار مواجه‌شده باید نزولی شود.
مقادیر برگشتی
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 مقدار 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
)

Iterate through the TLV data referenced by aReader and invoke aHandler for each visited TLV element in the context of 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
)

Iterate through the TLV data referenced by aReader and invoke aHandler for each visited TLV element in the context of 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 مقدار NULL داشته باشد.
The
آخرین مقدار برگردانده‌شده توسط aHandler، اگر با WEAVE_NO_ERROR متفاوت باشد

تکرار کردن

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

Iterate through the TLV data referenced by aReader and invoke aHandler for each visited TLV element in the context of 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 مقدار NULL داشته باشد.
The
آخرین مقدار برگردانده‌شده توسط aHandler، اگر با WEAVE_NO_ERROR متفاوت باشد