nl::Weave::Profiles::DeviceDescription::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
[อ่านอย่างเดียว] Exchange Manager Objective
FabricState
[อ่านอย่างเดียว] ออบเจ็กต์สถานะ Fabric
OnIdentifyResponseReceived

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

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

HandleIdentifyResponseFunct

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

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

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

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

AppState

void * AppState

ออบเจ็กต์สถานะที่กำหนดโดยแอปพลิเคชัน

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[อ่านอย่างเดียว] Exchange Manager Objective

FabricState

const WeaveFabricState * FabricState

[อ่านอย่างเดียว] ออบเจ็กต์สถานะ Fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

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

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

ยกเลิกการแลกเปลี่ยนAPI ที่กำลังดำเนินการอยู่ซึ่งรอการตอบกลับ

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

เริ่มต้น

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

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

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

SendIdentifyRequest

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

ส่งข้อความ ListRequest ไปยังที่อยู่ IP ที่กำหนด

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

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

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

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

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

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

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