nl::Weave::DeviceLayer::Internal::DeviceControlServer

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/internal/DeviceControlServer.h>

ใช้งานโปรไฟล์การควบคุมอุปกรณ์ Weave สำหรับอุปกรณ์ Weave

สรุป

การสืบทอด

รับค่าจาก:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

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

Init()
IsPairedToAccount() const override
virtual bool
เรียกใช้เพื่อตรวจสอบว่าอุปกรณ์จับคู่กับบัญชีอยู่หรือไม่
IsResetAllowed(uint16_t resetFlags) override
virtual bool
ตรวจสอบว่าอนุญาตให้มีการรีเซ็ตการกำหนดค่าที่ระบุหรือไม่
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
ระบุว่าได้มีการเปิดระบบป้องกันการกำหนดค่าอุปกรณ์ที่ดำเนินการไม่สำเร็จแล้ว
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
ระบุว่าได้ปิดระบบการกำหนดค่าอุปกรณ์ที่ล้มเหลวอย่างปลอดภัยแล้ว
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
บ่งบอกว่ากระบวนการ Remote Passive Rendezvous สิ้นสุดแล้ว
OnRemotePassiveRendezvousStarted(void) override
virtual void
ระบุว่ากระบวนการ Remote Passive Rendezvous เริ่มต้นแล้ว
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
รีเซ็ตการกำหนดค่าอุปกรณ์ทั้งหมดหรือบางส่วน
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
เริ่มการทดสอบระบบที่ระบุ
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
หยุดการทดสอบระบบที่ดำเนินอยู่
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
ตรวจสอบว่าการเชื่อมต่อเซิร์ฟเวอร์ (หากมี) ควรปิดก่อนที่จะรีเซ็ตการกำหนดค่าหรือไม่
WillCloseRemotePassiveRendezvous(void) override
virtual void
เตรียมตัวหยุด Remote Passive Rendezvous
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
เตรียมพร้อมสำหรับการนัดพบระยะไกลแบบแพสซีฟ

ฟังก์ชันที่มีการป้องกัน

DeviceControlServer()=default
DeviceControlServer(const DeviceControlServer &)=delete
DeviceControlServer(const DeviceControlServer &&)=delete
operator=(const DeviceControlServer &)=delete
~DeviceControlServer()=default

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

Init

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

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

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

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

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

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

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

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

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

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

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

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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

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

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

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

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

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

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

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

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

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

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

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

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

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

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

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

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

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

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

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

ฟังก์ชันที่มีการป้องกัน

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default