ไม่มี:: สาน:: โปรไฟล์:: รายละเอียดอุปกรณ์:: DeviceDescriptionClient

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

อ็อบเจ็กต์ไคลเอนต์สำหรับการออกคำขอรายละเอียดอุปกรณ์

สรุป

ตัวสร้างและตัวทำลาย

DeviceDescriptionClient (void)

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

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
ฟังก์ชันนี้มีหน้าที่ในการประมวลผลข้อความ IdentityResponse

คุณลักษณะสาธารณะ

AppState
void *
แอพลิเคชันกำหนดสถานะวัตถุ
ExchangeMgr
[อ่านอย่างเดียว] วัตถุตัวจัดการการแลกเปลี่ยน
FabricState
[อ่านอย่างเดียว] วัตถุสถานะผ้า
OnIdentifyResponseReceived

งานสาธารณะ

CancelExchange (void)
ยกเลิกการแลกเปลี่ยน IdentifyRequest ที่กำลังดำเนินการเพื่อรอการตอบกลับ
Init ( WeaveExchangeManager *exchangeMgr)
เริ่มต้นสถานะไคลเอ็นต์คำอธิบายอุปกรณ์
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
ส่งข้อความ IdentifyRequest ไปยังที่อยู่ IP เฉพาะ
SendIdentifyRequest (const IdentifyRequestMessage & msg)
ส่งข้อความ IdentifyRequest ที่ออกอากาศเพื่อค้นหาโหนด Weave
Shutdown (void)
ปิดไคลเอ็นต์คำอธิบายอุปกรณ์

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

HandleIdentifyResponseFunct

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

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

รายละเอียด
พารามิเตอร์
[in] appState
ตัวชี้ไปยังสถานะที่กำหนดโดยแอปพลิเคชันเมื่อสร้างบริบทการแลกเปลี่ยน IdentityRequest
[in] nodeId
ID โหนดสานของแหล่งข้อความ
[in] nodeAddr
ที่อยู่ IP ของโหนดที่ตอบสนอง
[in] msg
การอ้างอิงถึงข้อความ IdentifyResponse ที่เข้ามา

คุณลักษณะสาธารณะ

AppState

void * AppState

แอพลิเคชันกำหนดสถานะวัตถุ

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[อ่านอย่างเดียว] วัตถุตัวจัดการการแลกเปลี่ยน

FabricState

const WeaveFabricState * FabricState

[อ่านอย่างเดียว] วัตถุสถานะผ้า

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

งานสาธารณะ

ยกเลิกการแลกเปลี่ยน

WEAVE_ERROR CancelExchange(
  void
)

ยกเลิกการแลกเปลี่ยน IdentifyRequest ที่กำลังดำเนินการเพื่อรอการตอบกลับ

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

ในนั้น

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

เริ่มต้นสถานะไคลเอ็นต์คำอธิบายอุปกรณ์

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

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

ส่งข้อความ IdentifyRequest ไปยังที่อยู่ IP เฉพาะ

รายละเอียด
พารามิเตอร์
[in] nodeAddr
การอ้างอิงไปยังที่อยู่ IP ของโหนด Weave เพื่อสอบถาม
[in] msg
การอ้างอิงถึงข้อความ IdentifyRequest ที่จะส่ง
ส่งกลับค่า
WEAVE_ERROR_NO_MEMORY
หากการจัดสรรบริบทการแลกเปลี่ยนของบัฟเฟอร์แพ็กเก็ตล้มเหลว
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
รหัสข้อผิดพลาดเฉพาะของ Weave หรือแพลตฟอร์มที่ระบุว่ามีข้อผิดพลาดเกิดขึ้นซึ่งทำให้ไม่สามารถส่งคำสั่งระบุได้

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

ส่งข้อความ IdentifyRequest ที่ออกอากาศเพื่อค้นหาโหนด Weave

รายละเอียด
พารามิเตอร์
[in] msg
การอ้างอิงถึงข้อความ IdentifyRequest ที่จะส่ง

ปิดตัวลง

WEAVE_ERROR Shutdown(
  void
)

ปิดไคลเอ็นต์คำอธิบายอุปกรณ์

ฟังก์ชันนี้จะปิดบริบทการแลกเปลี่ยนที่ใช้งานอยู่และรีเซ็ตตัวชี้ วัตถุที่สามารถนำกลับมาใช้โดยการเรียก Init วิธีการอีกครั้ง

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