nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

#include <src/lib/profiles/device-description/DeviceDescription.h>

ออบเจ็กต์เซิร์ฟเวอร์สำหรับตอบกลับคำขอคำอธิบายอุปกรณ์

สรุป

การสืบทอด

รับค่าจาก nl::Weave::WeaveServerBase
Direct Known Subclasses: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

ผู้ผลิตและผู้ทำลาย

DeviceDescriptionServer(void)

ประเภทสาธารณะ

HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) typedef
void(*

แอตทริบิวต์สาธารณะ

AppState
void *
ตัวชี้สถานะที่กำหนดโดยแอปพลิเคชันเพื่อให้บริบทสำหรับโค้ดเรียกกลับ
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
ฟังก์ชันนี้มีหน้าที่ประมวลผลข้อความ IdentityRequest

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

Init(WeaveExchangeManager *exchangeMgr)
เริ่มต้นสถานะเซิร์ฟเวอร์คำอธิบายอุปกรณ์ และลงทะเบียนเพื่อรับข้อความคำอธิบายอุปกรณ์
Shutdown(void)
ปิดเซิร์ฟเวอร์คำอธิบายอุปกรณ์

ประเภทสาธารณะ

HandleIdentifyRequestFunct

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

แอตทริบิวต์สาธารณะ

AppState

void * AppState

ตัวชี้สถานะที่กำหนดโดยแอปพลิเคชันเพื่อให้บริบทสำหรับโค้ดเรียกกลับ

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

ฟังก์ชันนี้มีหน้าที่ประมวลผลข้อความ IdentityRequest

รายละเอียด
พารามิเตอร์
[in] appState
ตัวชี้ไปยังสถานะที่แอปพลิเคชันกำหนดเมื่อลงทะเบียนรับข้อความประเภทนี้
[in] nodeId
รหัสโหนด Weave ของแหล่งที่มาของข้อความ
[in] nodeAddr
ที่อยู่ IP ของแหล่งที่มาของข้อความ
[in] reqMsg
การอ้างอิงข้อความ ReferRequest ที่เข้ามาใหม่
[out] sendResp
การอ้างอิงไปยังบูลีนที่ควรตั้งค่าเป็น "จริง" หากควรส่งข้อความตอบกลับไปยังผู้เริ่มต้น
[out] respMsg
การอ้างอิงข้อความตัวระบุเพื่อส่งไปยังผู้เริ่มต้น

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

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

เริ่มต้น

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

param[in] ExchangeMgr ตัวชี้ไปยังตัวจัดการ Exchange ของ Weave

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

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

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

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