nl::Weave::TLV::Utilities

Namespace ini mencakup jenis dan antarmuka utilitas untuk mengelola dan menggunakan TLV Weave.

Ringkasan

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

Fungsi
Count(const TLVReader & aReader, size_t & aCount)
Hitung jumlah elemen TLV dalam pembaca TLV yang ditentukan, diurutkan turun ke dalam array atau struktur.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
Menghitung jumlah elemen TLV dalam pembaca TLV yang ditentukan, yang secara opsional menurun ke dalam array atau struktur.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Tingkatkan penghitung saat melakukan iterasi melalui data TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Telusuri tag yang ditentukan dalam pembaca TLV yang disediakan.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Menelusuri tag yang ditentukan dalam pembaca TLV yang disediakan, secara opsional dapat menurun ke dalam array atau struktur.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Telusuri elemen pertama yang cocok dengan predikat dalam pembaca TLV yang menurun ke dalam array atau struktur.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
Telusuri elemen pertama yang cocok dengan predikat dalam pembaca TLV secara opsional, jika ingin, ke dalam array atau struktur.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Telusuri tag yang ditentukan dalam pembaca TLV yang disediakan.
FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
Lakukan iterasi melalui data TLV yang dirujuk oleh aReader dan panggil aHandler untuk setiap elemen TLV yang dikunjungi dalam konteks aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Lakukan iterasi melalui data TLV yang dirujuk oleh aReader dan panggil aHandler untuk setiap elemen TLV yang dikunjungi dalam konteks aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Lakukan iterasi melalui data TLV yang dirujuk oleh aReader dan panggil aHandler untuk setiap elemen TLV yang dikunjungi dalam konteks aContext.

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

Typedef

IterateHandler

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

Fungsi

Jumlah

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

Hitung jumlah elemen TLV dalam pembaca TLV yang ditentukan, yang diurutkan turun ke dalam array atau struktur.

Detail
Parameter
[in] aReader
Referensi hanya baca ke pembaca TLV yang akan digunakan untuk menghitung jumlah elemen TLV.
[in,out] aCount
Referensi ke penyimpanan untuk jumlah yang ditampilkan. Nilai ini diinisialisasi ke nol (0) sebelum penghitungan dan disetel ke jumlah elemen yang dihitung setelah berhasil.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.

Jumlah

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

Menghitung jumlah elemen TLV dalam pembaca TLV yang ditentukan, yang secara opsional menurun ke dalam array atau struktur.

Detail
Parameter
[in] aReader
Referensi hanya baca ke pembaca TLV yang akan digunakan untuk menghitung jumlah elemen TLV.
[in,out] aCount
Referensi ke penyimpanan untuk jumlah yang ditampilkan. Nilai ini diinisialisasi ke nol (0) sebelum penghitungan dan disetel ke jumlah elemen yang dihitung setelah berhasil.
[in] aRecurse
Boolean yang menunjukkan apakah (true) atau tidak (false) setiap array atau struktur yang ditemui harus diturunkan.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.

CountHandler

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

Tingkatkan penghitung saat melakukan iterasi melalui data TLV.

Detail
Parameter
[in] aReader
Referensi ke pembaca TLV yang berisi data TLV untuk menghitung jumlah elemen TLV.
[in] aDepth
Kedalaman saat ini ke dalam data TLV.
[in,out] aContext
Pointer ke konteks khusus pengendali, yang merupakan pointer ke penyimpanan untuk nilai jumlah.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_INVALID_ARGUMENT
Jika aContext adalah NULL.

Temukan

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

Telusuri tag yang ditentukan dalam pembaca TLV yang disediakan.

Detail
Parameter
[in] aReader
Referensi hanya baca ke pembaca TLV untuk menemukan tag yang ditentukan.
[in] aTag
Referensi hanya baca ke tag TLV yang akan ditemukan.
[out] aResult
Referensi ke penyimpanan ke pembaca TLV yang akan diposisikan pada tag yang ditentukan jika berhasil.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jika tag yang ditentukan aTag tidak ditemukan.

Temukan

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

Menelusuri tag yang ditentukan dalam pembaca TLV yang disediakan, secara opsional dapat menurun ke dalam array atau struktur.

Detail
Parameter
[in] aReader
Referensi hanya baca ke pembaca TLV untuk menemukan tag yang ditentukan.
[in] aTag
Referensi hanya baca ke tag TLV yang akan ditemukan.
[out] aResult
Referensi ke penyimpanan ke pembaca TLV yang akan diposisikan pada tag yang ditentukan jika berhasil.
[in] aRecurse
Boolean yang menunjukkan apakah (true) atau tidak (false) setiap array atau struktur yang ditemui harus diturunkan.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jika tag yang ditentukan aTag tidak ditemukan.

Temukan

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

Telusuri elemen pertama yang cocok dengan predikat dalam pembaca TLV yang menurun ke dalam array atau struktur.

aPredicate diterapkan untuk setiap elemen TLV yang dikunjungi; aPredicate akan menampilkan WEAVE_ERROR_MAX untuk elemen yang cocok, WEAVE_NO_ERROR untuk elemen yang tidak cocok, dan nilai lainnya untuk menghentikan penelusuran.

Detail
Parameter
[in] aReader
Referensi hanya baca ke pembaca TLV untuk menemukan elemen yang cocok dengan predikat.
[in] aPredicate
Predikat yang akan diterapkan ke setiap elemen TLV. Untuk mendukung penggunaan ulang kode, aPredicate memiliki jenis IterateHandler. Nilai yang ditampilkan dari aPredikat mengontrol penelusuran: WEAVE_ERROR_MAX menandakan bahwa elemen yang diinginkan telah ditemukan, WEAVE_NO_ERROR menandakan bahwa elemen yang diinginkan belum ditemukan, dan semua nilai lainnya menandakan bahwa saerch harus dihentikan.
[in] aContext
Pointer opsional ke data konteks yang disediakan pemanggil.
[out] aResult
Referensi ke penyimpanan ke pembaca TLV yang akan diposisikan pada tag yang ditentukan jika berhasil.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jika aPredicate yang ditentukan tidak menemukan elemen yang ditentukan

Temukan

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

Telusuri elemen pertama yang cocok dengan predikat dalam pembaca TLV secara opsional, jika ingin, ke dalam array atau struktur.

aPredicate diterapkan untuk setiap elemen TLV yang dikunjungi; aPredicate akan menampilkan WEAVE_ERROR_MAX untuk elemen yang cocok, WEAVE_NO_ERROR untuk elemen yang tidak cocok, dan nilai lainnya untuk menghentikan penelusuran.

Detail
Parameter
[in] aReader
Referensi hanya baca ke pembaca TLV untuk menemukan elemen yang cocok dengan predikat.
[in] aPredicate
Predikat yang akan diterapkan ke setiap elemen TLV. Untuk mendukung penggunaan ulang kode, aPredicate memiliki jenis IterateHandler. Nilai yang ditampilkan dari aPredikat mengontrol penelusuran: WEAVE_ERROR_MAX menandakan bahwa elemen yang diinginkan telah ditemukan, WEAVE_NO_ERROR menandakan bahwa elemen yang diinginkan belum ditemukan, dan semua nilai lainnya menandakan bahwa saerch harus dihentikan.
[in] aContext
Pointer opsional ke data konteks yang disediakan pemanggil.
[out] aResult
Referensi ke penyimpanan ke pembaca TLV yang akan diposisikan pada tag yang ditentukan jika berhasil.
[in] aRecurse
Boolean yang menunjukkan apakah (true) atau tidak (false) setiap array atau struktur yang ditemui harus diturunkan.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Jika aPredicate yang ditentukan tidak menemukan elemen yang ditentukan

FindHandler

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

Telusuri tag yang ditentukan dalam pembaca TLV yang disediakan.

Detail
Parameter
[in] aReader
Referensi hanya baca ke pembaca TLV untuk menemukan tag yang ditentukan.
[in] aDepth
Kedalaman saat ini ke dalam data TLV.
[in,out] aContext
Pointer ke konteks khusus pengendali.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_INVALID_ARGUMENT
Jika aContext adalah NULL.
WEAVE_ERROR_MAX
Jika tag yang ditentukan ditemukan.

FindPredicateHandler

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

Ulangi

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

Lakukan iterasi melalui data TLV yang dirujuk oleh aReader dan panggil aHandler untuk setiap elemen TLV yang dikunjungi dalam konteks aContext.

Iterasi dibatalkan jika aHandler menampilkan apa pun selain WEAVE_NO_ERROR

Detail
Parameter
[in] aReader
Referensi ke pembaca TLV yang berisi data TLV yang akan diiterasi.
[in] aDepth
Kedalaman saat ini ke dalam data TLV.
[in] aHandler
Callback yang akan dipanggil untuk elemen TLV saat ini yang sedang dikunjungi.
[in,out] aContext
Pointer opsional ke data konteks yang disediakan pemanggil.
[in] aRecurse
Boolean yang menunjukkan apakah (true) atau tidak (false) setiap array atau struktur yang ditemui harus diturunkan.
Nilai yang Ditampilkan
WEAVE_END_OF_TLV
Pada iterasi yang berhasil ke akhir encoding TLV, atau ke akhir container TLV.
The
nilai terakhir yang ditampilkan oleh aHandler, jika berbeda dengan WEAVE_NO_ERROR

Ulangi

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

Lakukan iterasi melalui data TLV yang dirujuk oleh aReader dan panggil aHandler untuk setiap elemen TLV yang dikunjungi dalam konteks aContext.

Iterasi dibatalkan jika aHandler menampilkan apa pun selain WEAVE_NO_ERROR

Detail
Parameter
[in] aReader
Referensi ke pembaca TLV yang berisi data TLV yang akan diiterasi.
[in] aHandler
Callback yang akan dipanggil untuk elemen TLV saat ini yang sedang dikunjungi.
[in,out] aContext
Pointer opsional ke data konteks yang disediakan pemanggil.
Nilai yang Ditampilkan
WEAVE_END_OF_TLV
Pada iterasi yang berhasil ke akhir encoding TLV, atau ke akhir container TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Jika aHandler adalah NULL.
The
nilai terakhir yang ditampilkan oleh aHandler, jika berbeda dengan WEAVE_NO_ERROR

Ulangi

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

Lakukan iterasi melalui data TLV yang dirujuk oleh aReader dan panggil aHandler untuk setiap elemen TLV yang dikunjungi dalam konteks aContext.

Iterasi dibatalkan jika aHandler menampilkan apa pun selain WEAVE_NO_ERROR

Detail
Parameter
[in] aReader
Referensi ke pembaca TLV yang berisi data TLV yang akan diiterasi.
[in] aHandler
Callback yang akan dipanggil untuk elemen TLV saat ini yang sedang dikunjungi.
[in,out] aContext
Pointer opsional ke data konteks yang disediakan pemanggil.
[in] aRecurse
Boolean yang menunjukkan apakah (true) atau tidak (false) setiap array atau struktur yang ditemui harus diturunkan.
Nilai yang Ditampilkan
WEAVE_END_OF_TLV
Pada iterasi yang berhasil ke akhir encoding TLV, atau ke akhir container TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Jika aHandler adalah NULL.
The
nilai terakhir yang ditampilkan oleh aHandler, jika berbeda dengan WEAVE_NO_ERROR