หน้านี้ได้รับการแปลโดย Cloud Translation API

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

ชั้นเรียนนี้เป็นชั้นนามธรรม

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

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

สรุป

การสืบทอด

รับค่าจาก: nl::Weave::WeaveServerDelegateBase
คลาสย่อยที่รู้จักโดยตรง: 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` บ่งบอกว่ากระบวนการ Remote Passive Rendezvous สิ้นสุดแล้ว
`OnRemotePassiveRendezvousStarted(void)=0`	`virtual void` ระบุว่ากระบวนการ Remote Passive 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` เตรียมตัวหยุด Remote Passive Rendezvous
`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

บ่งบอกว่ากระบวนการ Remote Passive Rendezvous สิ้นสุดแล้ว

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

ระบุว่ากระบวนการ Remote Passive Rendezvous เริ่มต้นแล้ว

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

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

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

รายละเอียด

พารามิเตอร์

[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

เตรียมตัวหยุด Remote Passive Rendezvous

ดูเพิ่มเติม
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

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

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

รายละเอียด

ผลลัพธ์

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