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

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

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

สรุป

การสืบทอด

รับค่าจาก: nl::Weave::WeaveServerBase
คลาสย่อยที่รู้จักโดยตรง: 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 *
ตัวชี้สถานะที่กำหนดโดยแอปพลิเคชันเพื่อให้บริบทสำหรับ Callback
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
ฟังก์ชันนี้มีหน้าที่ประมวลผลข้อความ IdentityRequest

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

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

HandleIdentifyRequestFunct

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

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

AppState

void * AppState

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

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

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

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

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

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

เริ่มต้นสถานะ Device Description Server และลงทะเบียนเพื่อรับข้อความ Device Description

param[in] ExchangeMgr A ตัวชี้ไปยัง Weave Exchange Manager

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

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

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

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