nl::Weave::TLV::Utilities

Không gian tên này bao gồm các loại và giao diện tiện ích để quản lý và làm việc với TLV của Weave.

Tóm tắt

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

Hàm
Count(const TLVReader & aReader, size_t & aCount)
Đếm số phần tử TLV trong trình đọc TLV đã chỉ định, giảm dần theo mảng hoặc cấu trúc.
Count(const TLVReader & aReader, size_t & aCount, const bool aRecurse)
Đếm số phần tử TLV trong trình đọc TLV đã chỉ định (không bắt buộc) giảm dần theo mảng hoặc cấu trúc.
CountHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Tăng bộ đếm khi lặp lại thông qua dữ liệu TLV.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult)
Tìm thẻ đã chỉ định trong trình đọc TLV được cung cấp.
Find(const TLVReader & aReader, const uint64_t & aTag, TLVReader & aResult, const bool aRecurse)
Tìm thẻ đã chỉ định trong trình đọc TLV được cung cấp (không bắt buộc) giảm dần theo mảng hoặc cấu trúc.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult)
Tìm phần tử đầu tiên khớp với thuộc tính trong trình đọc TLV theo thứ tự giảm dần theo mảng hoặc cấu trúc.
Find(const TLVReader & aReader, IterateHandler aPredicate, void *aContext, TLVReader & aResult, const bool aRecurse)
Tìm phần tử đầu tiên khớp với thuộc tính trong trình đọc TLV (không bắt buộc) giảm dần theo mảng hoặc cấu trúc.
FindHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Tìm thẻ đã chỉ định trong trình đọc TLV được cung cấp.
FindPredicateHandler(const TLVReader & aReader, size_t aDepth, void *aContext)
Iterate(TLVReader & aReader, size_t aDepth, IterateHandler aHandler, void *aContext, bool aRecurse)
Lặp lại thông qua dữ liệu TLV do aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh của aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Lặp lại thông qua dữ liệu TLV do aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh của aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Lặp lại thông qua dữ liệu TLV do aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh của aContext.

Cấu trúc
nl::Weave::TLV::Utilities::FindContext
nl::Weave::TLV::Utilities::FindPredicateContext

Typedef

IterateHandler

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

Hàm

Số lượt

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

Đếm số phần tử TLV trong trình đọc TLV đã chỉ định, giảm dần theo mảng hoặc cấu trúc.

Chi tiết
Tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để đếm số lượng phần tử TLV.
[in,out] aCount
Thông tin tham chiếu đến bộ nhớ cho số lượng được trả về. Giá trị này được khởi tạo thành không (0) trước khi đếm và được đặt thành số phần tử được tính khi đếm thành công.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.

Số lượt

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

Đếm số phần tử TLV trong trình đọc TLV đã chỉ định (không bắt buộc) giảm dần theo mảng hoặc cấu trúc.

Chi tiết
Tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để đếm số lượng phần tử TLV.
[in,out] aCount
Thông tin tham chiếu đến bộ nhớ cho số lượng được trả về. Giá trị này được khởi tạo thành không (0) trước khi đếm và được đặt thành số phần tử được tính khi đếm thành công.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) bất kỳ mảng hoặc cấu trúc gặp phải nào sẽ được chuyển xuống.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.

CountHandler

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

Tăng bộ đếm khi lặp lại thông qua dữ liệu TLV.

Chi tiết
Tham số
[in] aReader
Tham chiếu đến trình đọc TLV chứa dữ liệu TLV để đếm số lượng phần tử TLV.
[in] aDepth
Thông tin chuyên sâu hiện tại về dữ liệu TLV.
[in,out] aContext
Con trỏ trỏ đến ngữ cảnh cụ thể của trình xử lý là con trỏ tới bộ nhớ dành cho giá trị số lượng.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu aContext là giá trị NULL.

Tìm

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

Tìm thẻ đã chỉ định trong trình đọc TLV được cung cấp.

Chi tiết
Tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm thẻ đã chỉ định.
[in] aTag
Tham chiếu chỉ đọc đến thẻ TLV cần tìm.
[out] aResult
Thông tin tham chiếu đến việc lưu trữ đến trình đọc TLV sẽ được đặt tại thẻ được chỉ định khi thành công.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Nếu không tìm thấy thẻ được chỉ định aTag.

Tìm

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

Tìm thẻ đã chỉ định trong trình đọc TLV được cung cấp (không bắt buộc) giảm dần theo mảng hoặc cấu trúc.

Chi tiết
Tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm thẻ đã chỉ định.
[in] aTag
Tham chiếu chỉ đọc đến thẻ TLV cần tìm.
[out] aResult
Thông tin tham chiếu đến việc lưu trữ đến trình đọc TLV sẽ được đặt tại thẻ được chỉ định khi thành công.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) bất kỳ mảng hoặc cấu trúc gặp phải nào sẽ được chuyển xuống.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Nếu không tìm thấy thẻ được chỉ định aTag.

Tìm

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

Tìm phần tử đầu tiên khớp với thuộc tính trong trình đọc TLV theo thứ tự giảm dần theo mảng hoặc cấu trúc.

aPredicate được áp dụng cho từng phần tử TLV đã truy cập; aPredicate sẽ trả về WEAVE_ERROR_MAX cho các phần tử phù hợp, WEAVE_NO_ERROR cho các phần tử không phù hợp và bất kỳ giá trị nào khác để chấm dứt tìm kiếm.

Chi tiết
Tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm phần tử khớp với vị từ.
[in] aPredicate
Một thuộc tính được áp dụng cho mỗi phần tử TLV. Để hỗ trợ việc sử dụng lại mã, aPredicate có kiểu IterateHandler. Giá trị trả về của aPredicate kiểm soát quá trình tìm kiếm: WEAVE_ERROR_MAX báo hiệu rằng đã tìm thấy phần tử mong muốn, WEAVE_NO_ERROR báo hiệu rằng không tìm thấy phần tử mong muốn và tất cả các giá trị khác báo hiệu rằng saerch cần bị chấm dứt.
[in] aContext
Con trỏ không bắt buộc trỏ đến dữ liệu ngữ cảnh do phương thức gọi cung cấp.
[out] aResult
Thông tin tham chiếu đến việc lưu trữ đến trình đọc TLV sẽ được đặt tại thẻ được chỉ định khi thành công.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Nếu aPredicate được chỉ định không tìm thấy phần tử được chỉ định

Tìm

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

Tìm phần tử đầu tiên khớp với thuộc tính trong trình đọc TLV (không bắt buộc) giảm dần theo mảng hoặc cấu trúc.

aPredicate được áp dụng cho từng phần tử TLV đã truy cập; aPredicate sẽ trả về WEAVE_ERROR_MAX cho các phần tử phù hợp, WEAVE_NO_ERROR cho các phần tử không phù hợp và bất kỳ giá trị nào khác để chấm dứt tìm kiếm.

Chi tiết
Tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm phần tử khớp với vị từ.
[in] aPredicate
Một thuộc tính được áp dụng cho mỗi phần tử TLV. Để hỗ trợ việc sử dụng lại mã, aPredicate có loại IterateHandler. Giá trị trả về của aPredicate kiểm soát quá trình tìm kiếm: WEAVE_ERROR_MAX báo hiệu rằng đã tìm thấy phần tử mong muốn, WEAVE_NO_ERROR báo hiệu rằng không tìm thấy phần tử mong muốn và tất cả các giá trị khác báo hiệu rằng saerch cần bị chấm dứt.
[in] aContext
Con trỏ không bắt buộc trỏ đến dữ liệu ngữ cảnh do phương thức gọi cung cấp.
[out] aResult
Thông tin tham chiếu đến việc lưu trữ đến trình đọc TLV sẽ được đặt tại thẻ được chỉ định khi thành công.
[in] aRecurse
Giá trị boolean cho biết liệu (true) hay không (false) các mảng hoặc cấu trúc gặp phải được chuyển xuống.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Nếu aPredicate được chỉ định không tìm thấy phần tử được chỉ định

FindHandler

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

Tìm thẻ đã chỉ định trong trình đọc TLV được cung cấp.

Chi tiết
Tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm thẻ đã chỉ định.
[in] aDepth
Thông tin chuyên sâu hiện tại về dữ liệu TLV.
[in,out] aContext
Con trỏ trỏ đến ngữ cảnh dành riêng cho trình xử lý.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu aContext là giá trị NULL.
WEAVE_ERROR_MAX
Nếu tìm thấy thẻ đã chỉ định.

FindPredicateHandler

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

Làm lại

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

Lặp lại thông qua dữ liệu TLV do aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh của aContext.

Thao tác lặp lại sẽ bị huỷ nếu aHandler trả về giá trị không phải là WEAVE_NO_ERROR

Chi tiết
Tham số
[in] aReader
Tham chiếu đến trình đọc TLV chứa dữ liệu TLV để lặp lại.
[in] aDepth
Thông tin chuyên sâu hiện tại về dữ liệu TLV.
[in] aHandler
Lệnh gọi lại để gọi phần tử TLV hiện đang được truy cập.
[in,out] aContext
Con trỏ không bắt buộc trỏ đến dữ liệu ngữ cảnh do phương thức gọi cung cấp.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) bất kỳ mảng hoặc cấu trúc gặp phải nào sẽ được chuyển xuống.
Giá trị trả về
WEAVE_END_OF_TLV
Khi lặp lại thành công đến cuối mã hoá TLV hoặc đến cuối vùng chứa TLV.
The
giá trị cuối cùng mà aHandler trả về, nếu khác với WEAVE_NO_ERROR

Làm lại

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

Lặp lại thông qua dữ liệu TLV do aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh của aContext.

Thao tác lặp lại sẽ bị huỷ nếu aHandler trả về giá trị không phải là WEAVE_NO_ERROR

Chi tiết
Tham số
[in] aReader
Tham chiếu đến trình đọc TLV chứa dữ liệu TLV để lặp lại.
[in] aHandler
Lệnh gọi lại để gọi phần tử TLV hiện đang được truy cập.
[in,out] aContext
Con trỏ không bắt buộc trỏ đến dữ liệu ngữ cảnh do phương thức gọi cung cấp.
Giá trị trả về
WEAVE_END_OF_TLV
Khi lặp lại thành công đến cuối mã hoá TLV hoặc đến cuối vùng chứa TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu aHandler là giá trị NULL.
The
giá trị cuối cùng mà aHandler trả về, nếu khác với WEAVE_NO_ERROR

Làm lại

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

Lặp lại thông qua dữ liệu TLV do aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh của aContext.

Thao tác lặp lại sẽ bị huỷ nếu aHandler trả về giá trị không phải là WEAVE_NO_ERROR

Chi tiết
Tham số
[in] aReader
Tham chiếu đến trình đọc TLV chứa dữ liệu TLV để lặp lại.
[in] aHandler
Lệnh gọi lại để gọi phần tử TLV hiện đang được truy cập.
[in,out] aContext
Con trỏ không bắt buộc trỏ đến dữ liệu ngữ cảnh do phương thức gọi cung cấp.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) bất kỳ mảng hoặc cấu trúc gặp phải nào sẽ được chuyển xuống.
Giá trị trả về
WEAVE_END_OF_TLV
Khi lặp lại thành công đến cuối mã hoá TLV hoặc đến cuối vùng chứa TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu aHandler là giá trị NULL.
The
giá trị cuối cùng mà aHandler trả về, nếu khác với WEAVE_NO_ERROR