nl::Weave::โปรไฟล์::DeviceControl::DeviceControlServer

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

คลาสของเซิร์ฟเวอร์สําหรับการใช้โปรไฟล์การควบคุมอุปกรณ์

สรุป

การสืบทอด

รับค่าจาก: nl::Weave::WeaveServerBase
Sub-known classes: nl::Weave::DeviceLayer::Internal::DeviceControlServer

เครื่องมือสร้างและตัวสร้าง
DeviceControlServer(void)

แอตทริบิวต์ที่ได้รับการปกป้อง
mCurClientOp
mDelegate
mFailSafeArmed
bool
mFailSafeToken
uint32_t
mRemotePassiveRendezvousClientCon
mRemotePassiveRendezvousEncryptionType
uint8_t
mRemotePassiveRendezvousJoinerAddr
mRemotePassiveRendezvousJoinerCon
mRemotePassiveRendezvousKeyId
uint16_t
mRemotePassiveRendezvousOp
mRemotePassiveRendezvousTimeout
uint16_t
mRemotePassiveRendezvousTunnel
mResetFlags
uint16_t
mTunnelInactivityTimeout
uint16_t

ฟังก์ชันสาธารณะ
Init(WeaveExchangeManager *exchangeMgr)
เริ่มต้นสถานะเซิร์ฟเวอร์การควบคุมอุปกรณ์ และลงทะเบียนเพื่อรับข้อความการควบคุมอุปกรณ์
IsRemotePassiveRendezvousInProgress(void) const
bool
ส่งคืนสถานะ Riveezvous ของแพสซีฟระยะไกล
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
ส่งการตอบกลับรายงานสถานะไปยังคําขอ
SendSuccessResponse(void)
virtual WEAVE_ERROR
ส่งการตอบสนองต่อคําขอควบคุมอุปกรณ์
SetDelegate(DeviceControlDelegate *delegate)
void
ตั้งค่าผู้รับมอบสิทธิ์ให้ประมวลผลเหตุการณ์ของเซิร์ฟเวอร์การควบคุมอุปกรณ์
Shutdown(void)
ปิดเซิร์ฟเวอร์การควบคุมอุปกรณ์
SystemTestTimeout(void)
void

แอตทริบิวต์ที่ได้รับการปกป้อง

mCurOO

ExchangeContext * mCurClientOp

ตัวแทน

DeviceControlDelegate * mDelegate

mFailSafeArmed

bool mFailSafeArmed

mFailSafeToken

uint32_t mFailSafeToken

mRemotePassiveRendezvousClientCon

WeaveConnection * mRemotePassiveRendezvousClientCon

ประเภทการเข้ารหัส mRemotePassiveRendezvous

uint8_t mRemotePassiveRendezvousEncryptionType

mRemotePassiveRendezvousjoinerAddr

IPAddress mRemotePassiveRendezvousJoinerAddr

mRemotePassiveRendezvousjoinerCon

WeaveConnection * mRemotePassiveRendezvousJoinerCon

mRemotePassiveRendezvousKeyId

uint16_t mRemotePassiveRendezvousKeyId

mRemotePassiveRendezvousOp

ExchangeContext * mRemotePassiveRendezvousOp

mRemotePassiveRendezvousTimeout

uint16_t mRemotePassiveRendezvousTimeout

mmPassiveRendezvousTunnel

WeaveConnectionTunnel * mRemotePassiveRendezvousTunnel

mresetFlags

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

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

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

 DeviceControlServer(
  void
)

เริ่ม

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

เริ่มต้นสถานะเซิร์ฟเวอร์การควบคุมอุปกรณ์ และลงทะเบียนเพื่อรับข้อความการควบคุมอุปกรณ์

รายละเอียด
พารามิเตอร์
[in] exchangeMgr
ตัวชี้ไปยัง Weave Exchange Manager
แสดงผลค่า
WEAVE_ERROR_INCORRECT_STATE
เมื่อมีการลงทะเบียนเซิร์ฟเวอร์ Riveezvous แบบแพสซีฟระยะไกลแล้ว
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
เมื่อมีการลงทะเบียนเครื่องจัดการข้อความที่ไม่พึงประสงค์มากเกินไป
WEAVE_NO_ERROR
สําเร็จแล้ว

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

ส่งคืนสถานะ Riveezvous ของแพสซีฟระยะไกล

รายละเอียด
แสดงผลค่า
TRUE
กรณีที่ Passive Rendezvous กําลังดําเนินการ
FALSE
หาก Rendezvous แบบระยะไกลไม่อยู่ระหว่างดําเนินการ

รายงานสถานะ

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

ส่งการตอบกลับรายงานสถานะไปยังคําขอ

รายละเอียด
พารามิเตอร์
[in] statusProfileId
รหัสสถานะโปรไฟล์ Weave นี้เกี่ยวข้องกับ
[in] statusCode
รหัสสถานะที่จะรวมอยู่ในการตอบกลับนี้
[in] sysError
รหัสข้อผิดพลาดของระบบที่จะรวมอยู่ในคําตอบนี้
แสดงผลค่า
WEAVE_ERROR_INCORRECT_STATE
หากไม่มีคําขอที่อยู่ระหว่างดําเนินการ
WEAVE_NO_ERROR
สําเร็จแล้ว
other
รหัสข้อผิดพลาดอื่นๆ ของ Weave หรือแพลตฟอร์มที่แสดงให้เห็นว่าเกิดข้อผิดพลาด ทําให้ไม่สามารถส่งรายงานสถานะได้

การตอบกลับที่สําเร็จ

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

ส่งการตอบสนองต่อคําขอควบคุมอุปกรณ์

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

ผู้รับมอบสิทธิ์

void SetDelegate(
  DeviceControlDelegate *delegate
)

ตั้งค่าผู้รับมอบสิทธิ์ให้ประมวลผลเหตุการณ์ของเซิร์ฟเวอร์การควบคุมอุปกรณ์

รายละเอียด
พารามิเตอร์
[in] delegate
ตัวชี้ไปยังการมอบสิทธิ์การควบคุมอุปกรณ์

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

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

รายละเอียด
แสดงผลค่า
WEAVE_NO_ERROR
โดยไม่มีเงื่อนไข

ระยะหมดเวลาของระบบทดสอบ

void SystemTestTimeout(
  void
)