nl:: Weave::TLV:: สาธารณูปโภค

เนมสเปซนี้ประกอบด้วยประเภทและอินเทอร์เฟซยูทิลิตีสําหรับการจัดการและทํางานกับ Weave TLV

สรุป

ประเภทคําจํากัดความ
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)
ค้นหาองค์ประกอบแรกที่ตรงกับ predicate ภายในเครื่องอ่าน 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)
ทําซ้ําผ่านข้อมูล TLV ที่ aReader อ้างอิง และเรียกใช้ aHandler สําหรับองค์ประกอบ TLV ที่เข้าชมแต่ละรายการในบริบทของ aContext
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext)
ทําซ้ําผ่านข้อมูล TLV ที่ aReader อ้างอิง และเรียกใช้ aHandler สําหรับองค์ประกอบ TLV ที่เข้าชมแต่ละรายการในบริบทของ aContext
Iterate(const TLVReader & aReader, IterateHandler aHandler, void *aContext, const bool aRecurse)
ทําซ้ําผ่านข้อมูล TLV ที่ aReader อ้างอิง และเรียกใช้ aHandler สําหรับองค์ประกอบ TLV ที่เข้าชมแต่ละรายการในบริบทของ aContext

โครงสร้าง
nl::Weave::TLV::ยูทิลิตี:FindContext
nl::Weave::TLV::ยูทิลิตี:FindPredicateContext

ประเภทคําจํากัดความ

เครื่องจัดการ Iterate

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
การอ้างอิงพื้นที่เก็บข้อมูลสําหรับจํานวนที่แสดงผล ค่านี้เริ่มต้นเป็นศูนย์ (0) ก่อนการนับ และกําหนดเป็นจํานวนองค์ประกอบที่นับสําเร็จ
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว

จำนวน

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

นับจํานวนขององค์ประกอบ TLV ภายในเครื่องอ่าน TLV ที่จะระบุหรือไม่ก็ได้ โดยจะจัดเรียงตามลําดับเป็นอาร์เรย์หรือโครงสร้าง

รายละเอียด
พารามิเตอร์
[in] aReader
การอ้างอิงแบบอ่านอย่างเดียวไปยังเครื่องอ่าน TLV ซึ่งสามารถนับจํานวนองค์ประกอบ TLV
[in,out] aCount
การอ้างอิงพื้นที่เก็บข้อมูลสําหรับจํานวนที่แสดงผล ค่านี้เริ่มต้นเป็นศูนย์ (0) ก่อนการนับ และกําหนดเป็นจํานวนองค์ประกอบที่นับสําเร็จ
[in] aRecurse
บูลีนที่ระบุว่า (true) อาร์เรย์ (หรือ) อาร์เรย์ที่พบหรือโครงสร้างควรสืบทอดต่อหรือไม่
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว

เครื่องจัดการ

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
บูลีนที่ระบุว่า (true) อาร์เรย์ (หรือ) อาร์เรย์ที่พบหรือโครงสร้างควรสืบทอดต่อหรือไม่
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว
WEAVE_ERROR_TLV_TAG_NOT_FOUND
หากไม่พบแท็ก aTag ที่ระบุ

ค้นหา

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

ค้นหาองค์ประกอบแรกที่ตรงกับ predicate ภายในเครื่องอ่าน TLV จากอาร์เรย์หรือโครงสร้าง

aPredicate จะใช้กับองค์ประกอบ TLV แต่ละรายการที่เข้าชม aPredicate จะแสดง WEhave_ERROR_MAX สําหรับองค์ประกอบที่ตรงกัน WEhave_NO_ERROR สําหรับองค์ประกอบที่ไม่ตรงกัน และค่าอื่นๆ ที่ต้องการสิ้นสุดการค้นหา

รายละเอียด
พารามิเตอร์
[in] aReader
การอ้างอิงแบบอ่านอย่างเดียวไปยังเครื่องอ่าน TLV สําหรับค้นหาองค์ประกอบที่ตรงกับเงื่อนไข
[in] aPredicate
คํากริยาที่จะใช้กับองค์ประกอบ TLV แต่ละรายการ aPredicate มีประเภท IterateHandler เพื่อสนับสนุนการใช้โค้ดซ้ํา ค่าการแสดงผลของ Prepredicate ในการควบคุมการค้นหา: พบสัญญาณ WEhave_ERROR_MAX ที่พบองค์ประกอบที่ต้องการ, WEhave_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 จะแสดง WEhave_ERROR_MAX สําหรับองค์ประกอบที่ตรงกัน WEhave_NO_ERROR สําหรับองค์ประกอบที่ไม่ตรงกัน และค่าอื่นๆ ที่ต้องการสิ้นสุดการค้นหา

รายละเอียด
พารามิเตอร์
[in] aReader
การอ้างอิงแบบอ่านอย่างเดียวไปยังเครื่องอ่าน TLV สําหรับค้นหาองค์ประกอบที่ตรงกับเงื่อนไข
[in] aPredicate
คํากริยาที่จะใช้กับองค์ประกอบ TLV แต่ละรายการ aPredicate มีประเภท IterateHandler เพื่อรองรับการใช้โค้ดซ้ํา ค่าการแสดงผลของ Prepredicate ในการควบคุมการค้นหา: พบสัญญาณ WEhave_ERROR_MAX ที่พบองค์ประกอบที่ต้องการ, WEhave_NO_ERROR ระบุว่าไม่พบองค์ประกอบที่ต้องการ และค่าอื่นๆ ทั้งหมดเป็นสัญญาณว่าควรมีการสิ้นสุดการเสียดสี
[in] aContext
ตัวชี้ที่ไม่บังคับเพื่อให้ข้อมูลบริบทที่ผู้โทรระบุ
[out] aResult
การอ้างอิงพื้นที่เก็บข้อมูลไปยังเครื่องอ่าน TLV ซึ่งจะอยู่ในตําแหน่งที่แท็กที่ระบุเมื่อยืนยันสําเร็จ
[in] aRecurse
บูลีนที่ระบุว่า (true) เป็น (false) อาร์เรย์หรือโครงสร้างใดๆ ที่พบควรเรียงตามลําดับจากมากไปน้อย
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว
WEAVE_ERROR_TLV_TAG_NOT_FOUND
หาก aPredicate ที่ระบุไม่พบองค์ประกอบที่ระบุ

เครื่องจัดการ

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
หากพบแท็กที่ระบุ

เครื่องจัดการเครื่องจัดการล่วงหน้า

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
)

ทําซ้ําผ่านข้อมูล TLV ที่ aReader อ้างอิง และเรียกใช้ aHandler สําหรับองค์ประกอบ TLV ที่เข้าชมแต่ละรายการในบริบทของ aContext

ระบบจะยกเลิกคําสั่งนี้ซ้ําหาก aHandler แสดงผลลัพธ์อื่นใดที่ไม่ใช่ WEhave_NO_ERROR

รายละเอียด
พารามิเตอร์
[in] aReader
การอ้างอิงไปยังเครื่องอ่าน TLV ที่มีข้อมูล TLV เพื่อทําซ้ํา
[in] aDepth
ความลึกของข้อมูล TLV ในปัจจุบัน
[in] aHandler
การเรียกกลับเพื่อเรียกใช้สําหรับองค์ประกอบ TLV ปัจจุบันที่มีการเข้าชม
[in,out] aContext
ตัวชี้ที่ไม่บังคับเพื่อให้ข้อมูลบริบทที่ผู้โทรระบุ
[in] aRecurse
บูลีนที่ระบุว่า (true) อาร์เรย์ (หรือ) อาร์เรย์ที่พบหรือโครงสร้างควรสืบทอดต่อหรือไม่
แสดงผลค่า
WEAVE_END_OF_TLV
การทําซ้ําที่ส่วนท้ายของการเข้ารหัส TLV หรือตอนท้ายของคอนเทนเนอร์ TLV
The
ค่าล่าสุดที่ aHandler ส่งคืน หากต่างจาก WEhave_NO_ERROR

ปรับราคาเสนอใหม่

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

ทําซ้ําผ่านข้อมูล TLV ที่ aReader อ้างอิง และเรียกใช้ aHandler สําหรับองค์ประกอบ TLV ที่เข้าชมแต่ละรายการในบริบทของ aContext

ระบบจะยกเลิกคําสั่งนี้ซ้ําหาก aHandler แสดงผลลัพธ์อื่นใดที่ไม่ใช่ WEhave_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 ส่งคืน หากต่างจาก WEhave_NO_ERROR

ปรับราคาเสนอใหม่

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

ทําซ้ําผ่านข้อมูล TLV ที่ aReader อ้างอิง และเรียกใช้ aHandler สําหรับองค์ประกอบ TLV ที่เข้าชมแต่ละรายการในบริบทของ aContext

ระบบจะยกเลิกคําสั่งนี้ซ้ําหาก aHandler แสดงผลลัพธ์อื่นใดที่ไม่ใช่ WEhave_NO_ERROR

รายละเอียด
พารามิเตอร์
[in] aReader
การอ้างอิงไปยังเครื่องอ่าน TLV ที่มีข้อมูล TLV เพื่อทําซ้ํา
[in] aHandler
การเรียกกลับเพื่อเรียกใช้สําหรับองค์ประกอบ TLV ปัจจุบันที่มีการเข้าชม
[in,out] aContext
ตัวชี้ที่ไม่บังคับเพื่อให้ข้อมูลบริบทที่ผู้โทรระบุ
[in] aRecurse
บูลีนที่ระบุว่า (true) อาร์เรย์ (หรือ) อาร์เรย์ที่พบหรือโครงสร้างควรสืบทอดต่อหรือไม่
แสดงผลค่า
WEAVE_END_OF_TLV
การทําซ้ําที่ส่วนท้ายของการเข้ารหัส TLV หรือตอนท้ายของคอนเทนเนอร์ TLV
WEAVE_ERROR_INVALID_ARGUMENT
หาก aHandler เป็น NULL
The
ค่าล่าสุดที่ aHandler ส่งคืน หากต่างจาก WEhave_NO_ERROR