จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ

ไม่มี:: สาน:: โปรไฟล์:: DataManagement_Legacy:: DMClient

#include <src/lib/profiles/data-management/Legacy/DMClient.h>

คลาสพื้นฐานที่เป็นนามธรรมสำหรับไคลเอ็นต์ WDM เฉพาะแอปพลิเคชัน

สรุป

DMClient เป็นลูกค้า WDM มาตรฐาน การใช้งานนั้นรวมถึงการสมัครสมาชิก/การแจ้งเตือนด้วย มันเป็นส่วนผสมของ DM ที่ ProtocolEngine ระดับซึ่งจัดการ Comms ข้อเหวี่ยงเปลี่ยนและนามธรรมเครือ ClientDataManager ชั้นกับบางส่วนของวิธีการสมัครใช้บริการที่เกี่ยวข้องกับการดำเนินการเพื่อให้ชั้นที่สูงขึ้นจะได้ไม่ต้องกังวลเกี่ยวกับพวกเขา

ตัวจัดการสำหรับงานสมัครส่วนใหญ่ที่เกี่ยวข้องกับการทำหน้าที่เป็นอะแดปเตอร์บางกว่า ClientNotifier วัตถุ ผู้ดำเนินการคลาสย่อยควรระมัดระวังในการเรียกเมธอด super-class ที่เกี่ยวข้องเพื่อเปลี่ยนข้อเหวี่ยงของตัวจัดการการสมัครสมาชิก

DMClient วิธีการร้องขอโดยทั่วไปมี 2 ลายเซ็นหนึ่งที่มีความชัดเจนโหนดปลายทาง ID และอื่น ๆ ที่มีปลายทางที่ระบุ ไม่ว่าในกรณีใด ความสามารถในการส่งข้อความไปยังผู้เผยแพร่จะขึ้นอยู่กับการผูกมัดที่มีอยู่ก่อนแล้วในไคลเอนต์ แต่ในกรณีแรก ID ปลายทางนั้นตั้งใจที่จะเลือกระหว่างปลายทางที่ถูกผูกไว้หลายปลายทาง และในกรณีที่สอง รายการในตารางการผูกจะถูกเลือกเป็นค่าเริ่มต้น สิ่งนี้มีประโยชน์ ตัวอย่างเช่น หากลูกค้าจะถูกผูกไว้กับผู้เผยแพร่เพียงรายเดียว

มรดก

สืบทอดมาจาก:
  nl::สาน::โปรไฟล์::DataManagement_Legacy::ProtocolEngine
  nl::Weave::Profiles::DataManagement_Legacy::ClientDataManager

ตัวสร้างและตัวทำลาย

DMClient (void)
ตัวสร้างเริ่มต้นสำหรับ DMClient วัตถุ
~DMClient (void)
destructor สำหรับ DMClient วัตถุ
ViewRequest (const uint64_t & aDestinationId, ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
ขอดูข้อมูลที่เผยแพร่
ViewRequest ( ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
ขอดูข้อมูลของผู้เผยแพร่เริ่มต้น
UpdateRequest (const uint64_t & aDestinationId, ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
ขออัปเดตข้อมูลที่เผยแพร่
UpdateRequest ( ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
ขออัปเดตข้อมูลของผู้เผยแพร่เริ่มต้น

คุณสมบัติที่ได้รับการป้องกัน

mUpdatePool [kUpdatePoolSize]
mViewPool [kViewPoolSize]

งานสาธารณะ

CancelTransactionRequest (uint16_t aTxnId, WEAVE_ERROR aError)
ขอยกเลิกการทำธุรกรรมที่ดำเนินการอยู่
Clear (void)
virtual void
ล้างรัฐภายในที่เกี่ยวข้องกับ DMClient วัตถุ
Finalize (void)
virtual void
ปิดปฏิบัติการ DMClient
IncompleteIndication ( Binding *aBinding, StatusReport & aReport)
virtual void
จัดการ "ความไม่สมบูรณ์" ของการผูกที่ลูกค้าใช้

ฟังก์ชันที่ได้รับการป้องกัน

NewUpdate (void)
NewView (void)
View *

ดูคำขอ

virtual WEAVE_ERROR ViewRequest(
  const uint64_t & aDestinationId,
  ReferencedTLVData & aPathList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

ขอดูข้อมูลที่เผยแพร่

ขอดูข้อมูลที่อยู่และจัดการโดยผู้เผยแพร่ระยะไกลที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aDestinationId
การอ้างอิงถึงรหัสโหนด 64 บิตของผู้เผยแพร่ระยะไกล
[in] aPathList
การอ้างอิงไปยัง ReferencedTLVData วัตถุที่มีรายการเส้นทาง TLV เข้ารหัสที่ระบุข้อมูลที่ร้องขอ
[in] aTxnId
ตัวระบุสำหรับธุรกรรม WDM ที่ตั้งค่าเพื่อจัดการการดำเนินการมุมมองนี้
[in] aTimeout
เวลาสูงสุดในหน่วยมิลลิวินาทีเพื่อรอการตอบสนองของมุมมอง
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
WEAVE_ERROR_NO_MEMORY
หากไม่สามารถจัดสรรธุรกรรมได้
คืนสินค้า
มิฉะนั้น WEAVE_ERROR สะท้อนให้เห็นถึงความล้มเหลวในการเริ่มต้นหรือเริ่มต้นการทำธุรกรรม

ดูคำขอ

virtual WEAVE_ERROR ViewRequest(
  ReferencedTLVData & aPathList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

ขอดูข้อมูลของผู้เผยแพร่เริ่มต้น

ขอดูข้อมูลที่อยู่และจัดการโดยผู้เผยแพร่ "เริ่มต้น" เช่น ผู้เผยแพร่รายแรก (หรือเท่านั้น) ในตารางการผูกข้อมูลของลูกค้า

รายละเอียด
พารามิเตอร์
[in] aPathList
การอ้างอิงไปยัง ReferencedTLVData วัตถุที่มีรายการเส้นทาง TLV เข้ารหัสที่ระบุข้อมูลที่ร้องขอ
[in] aTxnId
ตัวระบุสำหรับธุรกรรม WDM ที่ตั้งค่าเพื่อจัดการการดำเนินการมุมมองนี้
[in] aTimeout
เวลาสูงสุดในหน่วยมิลลิวินาทีเพื่อรอการตอบสนองของมุมมอง
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
WEAVE_ERROR_NO_MEMORY
หากไม่สามารถจัดสรรธุรกรรมได้
คืนสินค้า
มิฉะนั้น WEAVE_ERROR สะท้อนให้เห็นถึงความล้มเหลวในการเริ่มต้นหรือเริ่มต้นการทำธุรกรรม

UpdateRequest

virtual WEAVE_ERROR UpdateRequest(
  const uint64_t & aDestinationId,
  ReferencedTLVData & aDataList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

ขออัปเดตข้อมูลที่เผยแพร่

ขอให้ผู้เผยแพร่ระยะไกลอัปเดตข้อมูลภายใต้การจัดการ

รายละเอียด
พารามิเตอร์
[in] aDestinationId
การอ้างอิงถึงรหัสโหนด 64 บิตของผู้เผยแพร่ระยะไกลที่ส่งคำขอ
[in] aDataList
การอ้างอิงไปยัง ReferencedTLVData วัตถุที่มีรายการข้อมูล TLV เข้ารหัสที่มีตัวแทนของการปรับปรุงรวมถึงเส้นทางที่จะปรับปรุงซึ่งจะถูกนำไปใช้
[in] aTxnId
ตัวระบุสำหรับธุรกรรมที่ตั้งค่าเพื่อจัดการคำขออัปเดต
[in] aTimeout
เวลาสูงสุดในหน่วยมิลลิวินาทีเพื่อรอรายงานสถานะที่เกี่ยวข้อง
คืนสินค้า
WEAVE_NO_ERROR กับความสำเร็จหรือ WEAVE_ERROR_NO_MEMORY ถ้าการทำธุรกรรมการปรับปรุงไม่ได้รับการจัดสรร มิฉะนั้นกลับ WEAVE_ERROR สะท้อนให้เห็นถึงความล้มเหลวในการปรับปรุง

UpdateRequest

virtual WEAVE_ERROR UpdateRequest(
  ReferencedTLVData & aDataList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

ขออัปเดตข้อมูลของผู้เผยแพร่เริ่มต้น

ขอให้ผู้เผยแพร่ระยะไกลอัปเดตข้อมูลภายใต้การจัดการ เวอร์ชันนี้ส่งคำขอไปยังผู้เผยแพร่ที่เป็นเป้าหมายของการผูกค่าเริ่มต้นของลูกค้า

รายละเอียด
พารามิเตอร์
[in] aDataList
การอ้างอิงไปยัง ReferencedTLVData วัตถุที่มีรายการข้อมูล TLV เข้ารหัสที่มีตัวแทนของการปรับปรุงรวมถึงเส้นทางที่จะปรับปรุงซึ่งจะถูกนำไปใช้
[in] aTxnId
ตัวระบุสำหรับธุรกรรมที่ตั้งค่าเพื่อจัดการคำขออัปเดต
[in] aTimeout
เวลาสูงสุดในหน่วยมิลลิวินาทีเพื่อรอรายงานสถานะที่เกี่ยวข้อง
คืนสินค้า
WEAVE_NO_ERROR กับความสำเร็จหรือ WEAVE_ERROR_NO_MEMORY ถ้าการทำธุรกรรมการปรับปรุงไม่ได้รับการจัดสรร มิฉะนั้นกลับ WEAVE_ERROR สะท้อนให้เห็นถึงความล้มเหลวในการปรับปรุง

คุณสมบัติที่ได้รับการป้องกัน

mUpdatePool

Update mUpdatePool[kUpdatePoolSize]

mViewPool

View mViewPool[kViewPoolSize]

งานสาธารณะ

ยกเลิกธุรกรรมคำขอ

WEAVE_ERROR CancelTransactionRequest(
  uint16_t aTxnId,
  WEAVE_ERROR aError
)

ขอยกเลิกการทำธุรกรรมที่ดำเนินการอยู่

เมธอดนี้ไม่สร้างทราฟฟิกเครือข่าย แต่ปล่อยทรัพยากรที่จัดสรรสำหรับธุรกรรมที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aTxnId
จำนวนธุรกรรมที่จะยกเลิก หากมีการระบุ kTransactionIdNotSpecified ธุรกรรมทั้งหมดจะถูกยกเลิก
[in] aError
WEAVE_ERROR รายงานเมื่อยกเลิกการทำธุรกรรม
คืนสินค้า
WEAVE_NO_ERROR กับความสำเร็จหรือ WEAVE_ERROR สะท้อนให้เห็นถึงความล้มเหลวในการยกเลิกการทำธุรกรรม

ชัดเจน

virtual void Clear(
  void
)

ล้างรัฐภายในที่เกี่ยวข้องกับ DMClient วัตถุ

โดยเฉพาะอย่างยิ่ง วิธีการนี้จะล้างกลุ่มธุรกรรมของลูกค้าทั้งหมด สำหรับลูกค้าที่ได้รับในการใช้งาน จบ () วิธีการที่เป็นที่นิยมเพราะมันยังยกเลิกการสมัครสมาชิกและทำความสะอาดขึ้นการทำธุรกรรมและตารางที่มีผลผูกพัน

ดูสิ่งนี้ด้วย:
จบ()

DMClient

 DMClient(
  void
)

ตัวสร้างเริ่มต้นสำหรับ DMClient วัตถุ

ล้างสถานะภายในทั้งหมด DMClient ต้องเริ่มต้นอีกด้วย Init () ก่อนการใช้งาน

จบ

virtual void Finalize(
  void
)

ปิดปฏิบัติการ DMClient

ล้างสถานะการทำงานทั้งหมดที่เกี่ยวข้องกับไคลเอนต์และลบการสมัครสมาชิกที่เกี่ยวข้องทั้งหมดออกจากตัวแจ้ง หลังจากที่โทรไป จบ () DMClient อาจจะ reinitialized เพียงโดยการเรียก Init () จบ () ถูกเรียกโดย DMClient destructor แต่อาจจะเรียกว่าในกรณีที่ DMClient ต้องทำความสะอาดเช่นในกรณีของความล้มเหลวหรือการปิดชั่วคราว แต่อาจจะต้องมีการสร้างขึ้นในเวลาต่อมา

IncompleteIndication

virtual void IncompleteIndication(
  Binding *aBinding,
  StatusReport & aReport
)

จัดการ "ความไม่สมบูรณ์" ของการผูกที่ลูกค้าใช้

เมื่อการรวมล้มเหลวโดยไม่คาดคิด เช่น ถ้าการเชื่อมต่อที่เกี่ยวข้องกับการรวมถูกปิด วิธีนี้จะถูกเรียก

รายละเอียด
พารามิเตอร์
[in] aBinding
ตัวชี้ไป ผูก ที่ได้กลายเป็นที่ไม่สมบูรณ์
[in] aReport
การอ้างอิงถึงรายงานสถานะที่ให้เหตุผลสำหรับความล้มเหลว

~DMClient

virtual  ~DMClient(
  void
)

destructor สำหรับ DMClient วัตถุ

ล้างสถานะภายในทั้งหมด และหากจำเป็น ยกเลิกการสมัครที่รอดำเนินการ

ฟังก์ชันที่ได้รับการป้องกัน

อัพเดทใหม่

Update * NewUpdate(
  void
)

NewView

View * NewView(
  void
)