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 được 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 được chỉ định (không bắt buộc) theo thứ tự 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ẻ được 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ẻ được chỉ định trong trình đọc TLV được cung cấp, theo tuỳ ý 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 vị từ trong trình đọc TLV giảm dần theo các 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 vị từ trong trình đọc TLV (không bắt buộc) theo thứ tự 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ẻ được 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 qua dữ liệu TLV mà aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
Lặp lại qua dữ liệu TLV mà aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh aContext.
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
Lặp lại qua dữ liệu TLV mà aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh 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 được chỉ định, giảm dần theo mảng hoặc cấu trúc.

Thông tin chi tiết
Các tham số
[in] aReader
Giá trị tham chiếu chỉ đọc đến trình đọc TLV để đếm số lượng phần tử TLV.
[in,out] aCount
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ố lượng phần tử được tính khi 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 được chỉ định (không bắt buộc) theo thứ tự giảm dần theo mảng hoặc cấu trúc.

Thông tin chi tiết
Các tham số
[in] aReader
Giá trị tham chiếu chỉ đọc đến trình đọc TLV để đếm số lượng phần tử TLV.
[in,out] aCount
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ố lượng phần tử được tính khi thành công.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) có cần giảm dần mảng hoặc cấu trúc gặp phải hay khô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.

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

Tìm

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

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

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm thẻ được chỉ định.
[in] aTag
Tham chiếu chỉ đọc đến thẻ TLV để tìm.
[out] aResult
Tham chiếu đến bộ nhớ tới trình đọc TLV sẽ được định vị ở 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ẻ được chỉ định trong trình đọc TLV được cung cấp, theo tuỳ ý giảm dần theo mảng hoặc cấu trúc.

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm thẻ được chỉ định.
[in] aTag
Tham chiếu chỉ đọc đến thẻ TLV để tìm.
[out] aResult
Tham chiếu đến bộ nhớ tới trình đọc TLV sẽ được định vị ở thẻ được chỉ định khi thành công.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) có cần giảm dần mảng hoặc cấu trúc gặp phải hay khô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 vị từ trong trình đọc TLV giảm dần theo các mảng hoặc cấu trúc.

aPredicate được áp dụng cho mỗi phần tử TLV được truy cập; aPredicate sẽ trả về WEAVE_ERROR_MAX cho phần tử phù hợp, WEAVE_NO_ERROR cho 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.

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu chỉ có thể đọc đến trình đọc TLV để tìm phần tử khớp với vị từ.
[in] aPredicate
Một vị từ được áp dụng cho mỗi phần tử TLV. Để hỗ trợ tính năng sử dụng lại mã, aPredicate có loại IterateHandler. Giá trị trả về của aPredicate kiểm soát tìm kiếm: WEAVE_ERROR_MAX cho biết đã tìm thấy phần tử mong muốn, WEAVE_NO_ERROR cho biết không tìm thấy phần tử mong muốn và tất cả các giá trị khác cho biết saerch nên bị chấm dứt.
[in] aContext
Con trỏ tuỳ chọn đến dữ liệu ngữ cảnh do người gọi cung cấp.
[out] aResult
Tham chiếu đến bộ nhớ tới trình đọc TLV sẽ được định vị ở 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 vị từ trong trình đọc TLV (không bắt buộc) theo thứ tự giảm dần theo mảng hoặc cấu trúc.

aPredicate được áp dụng cho mỗi phần tử TLV được truy cập; aPredicate sẽ trả về WEAVE_ERROR_MAX cho phần tử phù hợp, WEAVE_NO_ERROR cho 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.

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu chỉ có thể đọc đến trình đọc TLV để tìm phần tử khớp với vị từ.
[in] aPredicate
Một vị từ được áp dụng cho mỗi phần tử TLV. Để hỗ trợ tính năng sử dụng lại mã, aPredicate có loại IterateHandler. Giá trị trả về của aPredicate kiểm soát tìm kiếm: WEAVE_ERROR_MAX cho biết đã tìm thấy phần tử mong muốn, WEAVE_NO_ERROR cho biết không tìm thấy phần tử mong muốn và tất cả các giá trị khác cho biết saerch nên bị chấm dứt.
[in] aContext
Con trỏ tuỳ chọn đến dữ liệu ngữ cảnh do người gọi cung cấp.
[out] aResult
Tham chiếu đến bộ nhớ tới trình đọc TLV sẽ được định vị ở thẻ được chỉ định khi thành công.
[in] aRecurse
Giá trị boolean cho biết giá trị (true) hay không (false) có cần giảm dần mảng hoặc cấu trúc gặp phải (false) hay khô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ẻ được chỉ định trong trình đọc TLV được cung cấp.

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu chỉ đọc đến trình đọc TLV để tìm thẻ được chỉ định.
[in] aDepth
Chiều sâu hiện tại của dữ liệu TLV.
[in,out] aContext
Con trỏ đến ngữ cảnh cụ thể của trình xử lý.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu aContext là NULL.
WEAVE_ERROR_MAX
Nếu tìm thấy thẻ được 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 qua dữ liệu TLV mà aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh aContext.

Vòng lặp bị huỷ nếu aHandler trả về bất kỳ giá trị nào khác WEAVE_NO_ERROR

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu đến trình đọc TLV có chứa dữ liệu TLV để lặp lại.
[in] aDepth
Chiều sâu hiện tại của dữ liệu TLV.
[in] aHandler
Lệnh gọi lại để gọi phần tử TLV hiện tại đang được truy cập.
[in,out] aContext
Con trỏ tuỳ chọn đến dữ liệu ngữ cảnh do người gọi cung cấp.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) có cần giảm dần mảng hoặc cấu trúc gặp phải hay không.
Giá trị trả về
WEAVE_END_OF_TLV
Khi lặp lại thành công đến điểm cuối của bộ mã hoá TLV hoặc đến cuối vùng chứa TLV.
The
giá trị cuối cùng do 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 qua dữ liệu TLV mà aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh aContext.

Vòng lặp bị huỷ nếu aHandler trả về bất kỳ giá trị nào khác WEAVE_NO_ERROR

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu đến trình đọc TLV có 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 tại đang được truy cập.
[in,out] aContext
Con trỏ tuỳ chọn đến dữ liệu ngữ cảnh do người gọi cung cấp.
Giá trị trả về
WEAVE_END_OF_TLV
Khi lặp lại thành công đến điểm cuối của bộ mã hoá TLV hoặc đến cuối vùng chứa TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu aHandler là NULL.
The
giá trị cuối cùng do 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 qua dữ liệu TLV mà aReader tham chiếu và gọi aHandler cho từng phần tử TLV đã truy cập trong ngữ cảnh aContext.

Vòng lặp bị huỷ nếu aHandler trả về bất kỳ giá trị nào khác WEAVE_NO_ERROR

Thông tin chi tiết
Các tham số
[in] aReader
Tham chiếu đến trình đọc TLV có 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 tại đang được truy cập.
[in,out] aContext
Con trỏ tuỳ chọn đến dữ liệu ngữ cảnh do người gọi cung cấp.
[in] aRecurse
Boolean cho biết liệu (true) hay không (false) có cần giảm dần mảng hoặc cấu trúc gặp phải hay không.
Giá trị trả về
WEAVE_END_OF_TLV
Khi lặp lại thành công đến điểm cuối của bộ mã hoá TLV hoặc đến cuối vùng chứa TLV.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu aHandler là NULL.
The
giá trị cuối cùng do aHandler trả về, nếu khác với WEAVE_NO_ERROR