nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

นี่คือคลาสนามธรรม

#include <src/lib/profiles/device-control/DeviceControl.h>

มอบสิทธิ์คลาสสำหรับการใช้การดำเนินการควบคุมอุปกรณ์ขาเข้าในอุปกรณ์ของเซิร์ฟเวอร์

สรุป

การสืบทอด

รับค่าจาก nl::Weave::WeaveServerDelegateBase
Direct Known Subclasses: nl::Weave::DeviceLayer::Internal::DeviceControlServer

ฟังก์ชันสาธารณะ

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
บังคับใช้การควบคุมการเข้าถึงระดับข้อความสำหรับข้อความคำขอ DeviceControl ที่เข้ามา
IsPairedToAccount() const
virtual bool
เรียกใช้เพื่อดูว่าปัจจุบันอุปกรณ์จับคู่กับบัญชีอยู่หรือไม่
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
ตรวจสอบว่าได้อนุญาตให้รีเซ็ตการกำหนดค่าที่ระบุหรือไม่
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
ระบุว่าจอภาพการเชื่อมต่อหมดเวลา
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
ระบุว่ามีการเปิดใช้การกำหนดค่าอุปกรณ์ที่ไม่ปลอดภัยแล้ว
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
ระบุว่าได้ปิดระบบการกำหนดค่าอุปกรณ์ที่ล้มเหลวอย่างปลอดภัยแล้ว
OnRemotePassiveRendezvousDone(void)=0
virtual void
บ่งบอกว่ากระบวนการตอบกลับแบบแพสซีฟระยะไกลเสร็จสิ้นแล้ว
OnRemotePassiveRendezvousStarted(void)=0
virtual void
บ่งบอกว่ากระบวนการ Rendezvous ระยะไกลเริ่มต้นแล้ว
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
รีเซ็ตการกำหนดค่าอุปกรณ์ทั้งหมดหรือบางส่วน
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
เริ่มการทดสอบระบบที่ระบุ
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
หยุดการทดสอบระบบที่กำลังดำเนินการ
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
พิจารณาว่าหากมีการเชื่อมต่อเซิร์ฟเวอร์ ควรปิดก่อนที่จะรีเซ็ตการกำหนดค่าหรือไม่
WillCloseRemotePassiveRendezvous(void)=0
virtual void
เตรียมหยุดการบริการแบบพาสซีฟระยะไกล
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
เตรียมตัวสำหรับการนัดพบแบบพาสซีฟระยะไกล

ฟังก์ชันสาธารณะ

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

บังคับใช้การควบคุมการเข้าถึงระดับข้อความสำหรับข้อความคำขอ DeviceControl ที่เข้ามา

รายละเอียด
พารามิเตอร์
[in] ec
ExchangeContext ที่ได้รับข้อความ
[in] msgProfileId
รหัสโปรไฟล์ของข้อความที่ได้รับ
[in] msgType
ประเภทข้อความของข้อความที่ได้รับ
[in] msgInfo
โครงสร้าง WeaveMessageInfo ที่มีข้อมูลเกี่ยวกับข้อความที่ได้รับ
[in,out] result
ค่าแจกแจงที่อธิบายผลการประเมินนโยบายการควบคุมการเข้าถึงสำหรับข้อความที่ได้รับ เมื่อเข้าสู่เมธอด ค่าจะแสดงให้เห็นผลลัพธ์ที่คาดการณ์ไว้ ณ จุดปัจจุบันของกระบวนการประเมิน เมื่อกลับมา ผลลัพธ์ควรเป็นผลลัพธ์การประเมินขั้นสุดท้ายของนโยบายการควบคุมการเข้าถึงสำหรับข้อความ

IsPairedToAccount

virtual bool IsPairedToAccount() const 

เรียกใช้เพื่อดูว่าปัจจุบันอุปกรณ์จับคู่กับบัญชีอยู่หรือไม่

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

ตรวจสอบว่าได้อนุญาตให้รีเซ็ตการกำหนดค่าที่ระบุหรือไม่

รายละเอียด
พารามิเตอร์
[in] resetFlags
แฟล็กซึ่งระบุการกำหนดค่าที่จะรีเซ็ต
แสดงผลค่า
TRUE
หากอนุญาตให้รีเซ็ตการกำหนดค่า
FALSE
หากไม่อนุญาตให้รีเซ็ตการกำหนดค่า

OnConnectionMonitorTimeout

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

ระบุว่าจอภาพการเชื่อมต่อหมดเวลา

ระบบจะเรียกใช้ฟังก์ชันนี้เมื่อเกิดระยะหมดเวลาของการตรวจสอบการเชื่อมต่อ กล่าวคือเมื่อตรวจไม่พบการตรวจสอบความพร้อมใช้งานจากโฮสต์ระยะไกลเป็นระยะเวลาหนึ่ง

รายละเอียด
พารามิเตอร์
[in] peerNodeId
รหัสโหนดของเพียร์ระยะไกลที่หมดเวลาการเชื่อมต่อ
[in] peerAddr
ที่อยู่ของเครื่องระยะไกล

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

ระบุว่ามีการเปิดใช้การกำหนดค่าอุปกรณ์ที่ไม่ปลอดภัยแล้ว

ระบบจะเรียกฟังก์ชันนี้เมื่อมีการเปิดระบบการกำหนดค่าอุปกรณ์เซิร์ฟเวอร์ไม่สำเร็จเพื่อตอบสนองต่อคำขอจากไคลเอ็นต์ ฟีเจอร์ความปลอดภัยล้มเหลวจะรีเซ็ตการกำหนดค่าอุปกรณ์เป็นสถานะที่รู้จักโดยอัตโนมัติ หากขั้นตอนการกำหนดค่าล้มเหลว

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
ความสำเร็จ
other
รหัสข้อผิดพลาดอื่นๆ ของ Weave หรือรหัสข้อผิดพลาดเฉพาะแพลตฟอร์มซึ่งบ่งชี้ว่าเกิดข้อผิดพลาดที่ป้องกันไม่ให้เกิดข้อผิดพลาด

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

ระบุว่าได้ปิดระบบการกำหนดค่าอุปกรณ์ที่ล้มเหลวอย่างปลอดภัยแล้ว

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

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
ความสำเร็จ
other
รหัสข้อผิดพลาดอื่นๆ ของ Weave หรือรหัสข้อผิดพลาดเฉพาะแพลตฟอร์มซึ่งบ่งชี้ว่าเกิดข้อผิดพลาดที่ป้องกันไม่ให้ระบบปิดระบบความล้มเหลว

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

บ่งบอกว่ากระบวนการตอบกลับแบบแพสซีฟระยะไกลเสร็จสิ้นแล้ว

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

บ่งบอกว่ากระบวนการ Rendezvous ระยะไกลเริ่มต้นแล้ว

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

รีเซ็ตการกำหนดค่าอุปกรณ์ทั้งหมดหรือบางส่วน

การใช้งานฟังก์ชันนี้น่าจะรีเซ็ตค่าผสมของการกำหนดค่าเครือข่าย, Weave Fabric หรือบริการให้เป็นสถานะที่รู้จักตามการตั้งค่าสถานะการรีเซ็ต

รายละเอียด
พารามิเตอร์
[in] resetFlags
แฟล็กซึ่งระบุการกำหนดค่าที่จะรีเซ็ต
แสดงผลค่า
WEAVE_NO_ERROR
ความสำเร็จ
other
รหัสข้อผิดพลาด Weave หรือรหัสข้อผิดพลาดเฉพาะแพลตฟอร์มอื่นๆ ที่ระบุว่าเกิดข้อผิดพลาดที่ทำให้อุปกรณ์รีเซ็ตการกำหนดค่าไม่ได้

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

เริ่มการทดสอบระบบที่ระบุ

รายละเอียด
พารามิเตอร์
[in] profileId
รหัสของโปรไฟล์ของการทดสอบที่ขอ
[in] testId
รหัสของการทดสอบที่ขอ
แสดงผลค่า
WEAVE_NO_ERROR
ความสำเร็จ
other
รหัสข้อผิดพลาดอื่นๆ ของ Weave หรือรหัสข้อผิดพลาดเฉพาะแพลตฟอร์มซึ่งระบุว่าเกิดข้อผิดพลาดที่ทำให้ไม่สามารถเริ่มการทดสอบระบบ

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

หยุดการทดสอบระบบที่กำลังดำเนินการ

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
ความสำเร็จ
other
รหัสข้อผิดพลาดอื่นๆ ของ Weave หรือรหัสข้อผิดพลาดเฉพาะแพลตฟอร์มซึ่งระบุว่าเกิดข้อผิดพลาดที่ขัดขวางการหยุดการทดสอบระบบ

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

พิจารณาว่าหากมีการเชื่อมต่อเซิร์ฟเวอร์ ควรปิดก่อนที่จะรีเซ็ตการกำหนดค่าหรือไม่

ฟังก์ชันนี้ใช้เพื่อค้นหาผู้รับมอบสิทธิ์สำหรับการทำงานที่ต้องการเมื่อประมวลผลคำขอรีเซ็ตการกำหนดค่า หากการเชื่อมต่อเซิร์ฟเวอร์ทำงานอยู่ การตอบสนองด้วย TRUE สำหรับเมธอดนี้จะทำให้การเชื่อมต่อนั้นถูกปิดก่อนที่จะมีการทริกเกอร์การรีเซ็ตการกำหนดค่าผ่านเมธอด OnresetConfig

รายละเอียด
พารามิเตอร์
[in] resetFlags
แฟล็กซึ่งระบุการกำหนดค่าที่จะรีเซ็ต
แสดงผลค่า
true
หากต้องปิดการเชื่อมต่อ
false
หากไม่จำเป็นต้องปิดการเชื่อมต่อ

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

เตรียมหยุดการบริการแบบพาสซีฟระยะไกล

โปรดดูข้อมูลเพิ่มเติมที่
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

เตรียมตัวสำหรับการนัดพบแบบพาสซีฟระยะไกล

ตัวอย่างเช่น ทำให้เครือข่าย 15.4/Thread สามารถเข้าร่วมได้

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
ความสำเร็จ
other
รหัสข้อผิดพลาด Weave หรือรหัสข้อผิดพลาดเฉพาะแพลตฟอร์มอื่นๆ ที่ระบุว่าเกิดข้อผิดพลาดขณะเตรียมเริ่มการรับมือแบบพาสซีฟระยะไกล