nl :: Dệt :: TLV :: Tiện ích
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 Weave TLV .
Tóm lược
Typedefs |
---|
IterateHandler )(const TLVReader &aReader, size_t aDepth, void *aContext) | typedef |
Chức năng |
---|
Count (constTLVReader & aReader, size_t & aCount) | Đếm số phần tử TLV trong bộ đọc TLV được chỉ định, giảm dần thành các mảng hoặc cấu trúc. |
Count (constTLVReader & aReader, size_t & aCount, const bool aRecurse) | Đếm số phần tử TLV trong trình đọc TLV được chỉ định, tùy chọn giảm dần thành các mảng hoặc cấu trúc. |
CountHandler (constTLVReader & aReader, size_t aDepth, void *aContext) | Tăng bộ đếm khi lặp qua dữ liệu TLV . |
Find (constTLVReader & aReader, const uint64_t & aTag,TLVReader & aResult) | Tìm kiếm thẻ được chỉ định trong trình đọc TLV được cung cấp. |
Find (constTLVReader & aReader, const uint64_t & aTag,TLVReader & aResult, const bool aRecurse) | Tìm kiếm thẻ được chỉ định trong trình đọc TLV được cung cấp, tùy chọn giảm dần thành các mảng hoặc cấu trúc. |
Find (constTLVReader & aReader, IterateHandler aPredicate, void *aContext,TLVReader & aResult) | Tìm kiếm phần tử đầu tiên phù hợp với vị từ trong trình đọc TLV giảm dần thành các mảng hoặc cấu trúc. |
Find (constTLVReader & aReader, IterateHandler aPredicate, void *aContext,TLVReader & aResult, const bool aRecurse) | Tìm kiếm phần tử đầu tiên phù hợp với vị từ trong trình đọc TLV tùy ý giảm dần thành các mảng hoặc cấu trúc. |
FindHandler (constTLVReader & aReader, size_t aDepth, void *aContext) | Tìm kiếm thẻ được chỉ định trong trình đọc TLV được cung cấp. |
FindPredicateHandler (constTLVReader & 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 được tham chiếu bởi aReader và gọi aHandler cho mỗi phần tử TLV đã truy cập trong ngữ cảnh của aContext . |
Iterate (constTLVReader & aReader, IterateHandler aHandler, void *aContext) | Lặp lại thông qua dữ liệu TLV được tham chiếu bởi aReader và gọi aHandler cho mỗi phần tử TLV đã truy cập trong ngữ cảnh của aContext . |
Iterate (constTLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse) | Lặp lại thông qua dữ liệu TLV được tham chiếu bởi aReader và gọi aHandler cho mỗi phần tử TLV đã truy cập trong ngữ cảnh của aContext . |
Typedefs
IterateHandler
WEAVE_ERROR(* IterateHandler)(const TLVReader &aReader, size_t aDepth, void *aContext)
Chức năng
Đếm
WEAVE_ERROR Count(
const TLVReader & aReader,
size_t & aCount
)
Đếm số phần tử TLV trong bộ đọc TLV được chỉ định, giảm dần thành các mảng hoặc cấu trúc.
Chi tiết | Thông số | [in] aReader | Tham chiếu chỉ đọc đến trình đọc TLV để đếm số phần tử TLV . | [in,out] aCount | Tham chiếu đến bộ nhớ cho số lượng trả về. Điều 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 thành công. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về thành công. |
|
Đếm
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, tùy chọn giảm dần thành các mảng hoặc cấu trúc.
Chi tiết | Thông số | [in] aReader | Tham chiếu chỉ đọc đến trình đọc TLV để đếm số phần tử TLV . | [in,out] aCount | Tham chiếu đến bộ nhớ cho số lượng trả về. Điều 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 thành công. | [in] aRecurse | Một 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 nên được chuyển xuống. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về thành công. |
|
CountHandler
WEAVE_ERROR CountHandler(
const TLVReader & aReader,
size_t aDepth,
void *aContext
)
Tăng bộ đếm khi lặp qua dữ liệu TLV .
Chi tiết | Thông số | [in] aReader | Tham chiếu đến trình đọc TLV chứa dữ liệu TLV để đếm số phần tử TLV . | [in] aDepth | Độ sâu hiện tại của dữ liệu TLV . | [in,out] aContext | Một con trỏ đến ngữ cảnh cụ thể của trình xử lý, là một con trỏ tới bộ lưu trữ cho giá trị đếm. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về thành công. | WEAVE_ERROR_INVALID_ARGUMENT | Nếu aContext là NULL. |
|
Tìm thấy
WEAVE_ERROR Find(
const TLVReader & aReader,
const uint64_t & aTag,
TLVReader & aResult
)
Tìm kiếm thẻ được chỉ định trong trình đọc TLV được cung cấp.
Chi tiết | Thông 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 cần tìm. | [out] aResult | Tham chiếu đến bộ nhớ tới trình đọc TLV sẽ được đặt tại thẻ được chỉ định khi thành công. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về 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 thấy
WEAVE_ERROR Find(
const TLVReader & aReader,
const uint64_t & aTag,
TLVReader & aResult,
const bool aRecurse
)
Tìm kiếm thẻ được chỉ định trong trình đọc TLV được cung cấp, tùy chọn giảm dần thành các mảng hoặc cấu trúc.
Chi tiết | Thông 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 cần tìm. | [out] aResult | Tham chiếu đến bộ nhớ tới trình đọc TLV sẽ được đặt tại thẻ được chỉ định khi thành công. | [in] aRecurse | Một 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 nên được chuyển xuống. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về 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 thấy
WEAVE_ERROR Find(
const TLVReader & aReader,
IterateHandler aPredicate,
void *aContext,
TLVReader & aResult
)
Tìm kiếm phần tử đầu tiên phù hợp với vị từ trong trình đọc TLV giảm dần thành các mảng hoặc cấu trúc.
APredicate được áp dụng cho mỗi 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 khớp và bất kỳ giá trị nào khác để kết thúc tìm kiếm.
Chi tiết | Thông số | [in] aReader | Tham chiếu chỉ đọc tới trình đọc TLV để tìm thành phần phù hợp với vị ngữ. | [in] aPredicate | Một vị từ đượ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 việc tìm kiếm: WEAVE_ERROR_MAX báo hiệu rằng phần tử mong muốn đã được tìm thấy, WEAVE_NO_ERROR báo hiệu rằng phần tử mong muốn chưa được tìm thấy và tất cả các giá trị khác báo hiệu rằng saerch nên được kết thúc. | [in] aContext | Một con trỏ tùy chọn tới 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 đặt tại thẻ được chỉ định khi thành công. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về 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 thấy
WEAVE_ERROR Find(
const TLVReader & aReader,
IterateHandler aPredicate,
void *aContext,
TLVReader & aResult,
const bool aRecurse
)
Tìm kiếm phần tử đầu tiên phù hợp với vị từ trong trình đọc TLV theo tùy chọn xuống dưới các mảng hoặc cấu trúc.
APredicate được áp dụng cho mỗi 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 để kết thúc tìm kiếm.
Chi tiết | Thông số | [in] aReader | Tham chiếu chỉ đọc tới trình đọc TLV để tìm thành phần phù hợp với vị ngữ. | [in] aPredicate | Một vị từ được áp dụng cho mỗi phần tử TLV . Để hỗ trợ việc tái sử dụng mã, aPredicate có kiểu IterateHandler . Giá trị trả về của aPredicate kiểm soát việc tìm kiếm: WEAVE_ERROR_MAX báo hiệu rằng phần tử mong muốn đã được tìm thấy, WEAVE_NO_ERROR báo hiệu rằng phần tử mong muốn chưa được tìm thấy và tất cả các giá trị khác báo hiệu rằng saerch nên được kết thúc. | [in] aContext | Một con trỏ tùy chọn tới 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 đặt tại thẻ được chỉ định khi thành công. | [in] aRecurse | Một 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 nên được chuyển xuống. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về 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 kiếm thẻ được chỉ định trong trình đọc TLV được cung cấp.
Chi tiết | Thông số | [in] aReader | Tham chiếu chỉ đọc đến trình đọc TLV để tìm thẻ được chỉ định. | [in] aDepth | Độ sâu hiện tại của dữ liệu TLV . | [in,out] aContext | Một con trỏ đến ngữ cảnh cụ thể của trình xử lý. |
|
Giá trị trả lại | WEAVE_NO_ERROR | Về thành công. | WEAVE_ERROR_INVALID_ARGUMENT | Nếu aContext là NULL. | WEAVE_ERROR_MAX | Nếu thẻ được chỉ định được tìm thấy. |
|
FindPredicateHandler
WEAVE_ERROR FindPredicateHandler(
const TLVReader & aReader,
size_t aDepth,
void *aContext
)
Lặp 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 được tham chiếu bởi aReader và gọi aHandler cho mỗi phần tử TLV đã truy cập trong ngữ cảnh của aContext .
Việc lặp lại bị hủy bỏ nếu aHandler trả về bất kỳ thứ gì khác ngoài WEAVE_NO_ERROR
Chi tiết | Thông số | [in] aReader | Tham chiếu đến trình đọc TLV chứa dữ liệu TLV cần lặp lại. | [in] aDepth | Độ sâu hiện tại của dữ liệu TLV . | [in] aHandler | Một lệnh gọi lại để gọi phần tử TLV hiện tại đang được truy cập. | [in,out] aContext | Một con trỏ tùy chọn tới dữ liệu ngữ cảnh do người gọi cung cấp. | [in] aRecurse | Một 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 nên được chuyển xuống. |
|
Giá trị trả lại | WEAVE_END_OF_TLV | Khi lặp lại thành công đến cuối mã hóa TLV hoặc đến cuối vùng chứa TLV . | The | |
|
Lặp lại
WEAVE_ERROR Iterate(
const TLVReader & aReader,
IterateHandler aHandler,
void *aContext
)
Lặp lại thông qua dữ liệu TLV được tham chiếu bởi aReader và gọi aHandler cho mỗi phần tử TLV đã truy cập trong ngữ cảnh của aContext .
Việc lặp lại bị hủy bỏ nếu aHandler trả về bất kỳ thứ gì khác ngoài WEAVE_NO_ERROR
Chi tiết | Thông số | [in] aReader | Tham chiếu đến trình đọc TLV chứa dữ liệu TLV cần lặp lại. | [in] aHandler | Một lệnh gọi lại để gọi phần tử TLV hiện tại đang được truy cập. | [in,out] aContext | Một con trỏ tùy chọn tới dữ liệu ngữ cảnh do người gọi cung cấp. |
|
Giá trị trả lại | WEAVE_END_OF_TLV | Khi lặp lại thành công đến cuối mã hóa TLV hoặc đến cuối vùng chứa TLV . | WEAVE_ERROR_INVALID_ARGUMENT | Nếu aHandler là NULL. | The | |
|
Lặp 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 được tham chiếu bởi aReader và gọi aHandler cho mỗi phần tử TLV đã truy cập trong ngữ cảnh của aContext .
Việc lặp lại bị hủy bỏ nếu aHandler trả về bất kỳ thứ gì khác ngoài WEAVE_NO_ERROR
Chi tiết | Thông số | [in] aReader | Tham chiếu đến trình đọc TLV chứa dữ liệu TLV cần lặp lại. | [in] aHandler | Một lệnh gọi lại để gọi phần tử TLV hiện tại đang được truy cập. | [in,out] aContext | Một con trỏ tùy chọn tới dữ liệu ngữ cảnh do người gọi cung cấp. | [in] aRecurse | Một 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 nên được chuyển xuống. |
|
Giá trị trả lại | WEAVE_END_OF_TLV | Khi lặp lại thành công đến cuối mã hóa TLV hoặc đến cuối vùng chứa TLV . | WEAVE_ERROR_INVALID_ARGUMENT | Nếu aHandler là NULL. | The | |
|