nl::Weave::Profiles::DeviceControl::DeviceControlServer

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

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

สรุป

การสืบทอด

รับค่าจาก: nl::Weave::WeaveServerBase
คลาสย่อยที่รู้จักโดยตรง: 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
กลับสู่สถานะ Rendezvous แบบแพสซีฟระยะไกล
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

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

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

DeviceControlDelegate * mDelegate

mFailSafeArmed

bool mFailSafeArmed

mFailSafeToken

uint32_t mFailSafeToken

mRemotePassiveRendezvousClientCon

WeaveConnection * mRemotePassiveRendezvousClientCon

mRemotePassiveRendezvousEncryptionType

uint8_t mRemotePassiveRendezvousEncryptionType

mRemotePassiveRendezvousJoinerAddr

IPAddress mRemotePassiveRendezvousJoinerAddr

mRemotePassiveRendezvousJoinerCon

WeaveConnection * mRemotePassiveRendezvousJoinerCon

mRemotePassiveRendezvousKeyId

uint16_t mRemotePassiveRendezvousKeyId

mRemotePassiveRendezvousOp

ExchangeContext * mRemotePassiveRendezvousOp

mRemotePassiveRendezvousTimeout

uint16_t mRemotePassiveRendezvousTimeout

mRemotePassiveRendezvousTunnel

WeaveConnectionTunnel * mRemotePassiveRendezvousTunnel

mResetFlags

uint16_t mResetFlags

mTunnelInactivityTimeout

uint16_t mTunnelInactivityTimeout

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

DeviceControlServer

 DeviceControlServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

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

IsRemotePassiveRendezvousInProgress

bool IsRemotePassiveRendezvousInProgress(
  void
) const

กลับสู่สถานะ Rendezvous แบบแพสซีฟระยะไกล

รายละเอียด
ผลลัพธ์
TRUE
หากการทำงานแบบ Passive Rendezvous ระยะไกลกำลังดำเนินอยู่
FALSE
หากไม่มีการทำงานแบบ Passive Rendezvous จากระยะไกล

SendStatusReport

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 หรือแพลตฟอร์มเฉพาะที่ระบุว่าเกิดข้อผิดพลาดที่ทำให้ส่งรายงานสถานะไม่ได้

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

ส่งการตอบกลับคำขอระบบควบคุมอุปกรณ์ที่สำเร็จ

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

SetDelegate

void SetDelegate(
  DeviceControlDelegate *delegate
)

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

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

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

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

รายละเอียด
ผลลัพธ์
WEAVE_NO_ERROR
อย่างไม่มีเงื่อนไข

SystemTestTimeout

void SystemTestTimeout(
  void
)