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

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

ใช้งานโปรไฟล์ Weave Device Control สำหรับอุปกรณ์ 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
บ่งบอกว่ากระบวนการตอบกลับแบบแพสซีฟระยะไกลเสร็จสิ้นแล้ว
OnRemotePassiveRendezvousStarted(void) override
virtual void
บ่งบอกว่ากระบวนการ 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
เตรียมหยุดการบริการแบบพาสซีฟระยะไกล
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
เตรียมตัวสำหรับการนัดพบแบบพาสซีฟระยะไกล

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

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

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

เริ่มต้น

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

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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

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

รายละเอียด
พารามิเตอร์
[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

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

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

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

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

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

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

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

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

โอเปอเรเตอร์=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~เซิร์ฟเวอร์การควบคุมอุปกรณ์

 ~DeviceControlServer()=default