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

ฟังก์ชันสาธารณะ
CancelExchange(void)
ยกเลิกการแลกเปลี่ยน VerifyRequest ที่กำลังดำเนินการอยู่และรอการตอบกลับอยู่
Init(WeaveExchangeManager *exchangeMgr)
เริ่มต้นสถานะไคลเอ็นต์คำอธิบายอุปกรณ์
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
ส่งข้อความ ContextRequest ไปยังที่อยู่ IP หนึ่งๆ
SendIdentifyRequest(const IdentifyRequestMessage & msg)
ส่งข้อความ identifierRequest ที่เผยแพร่เพื่อค้นหาโหนด 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
การอ้างอิงข้อความ identifierResponse ที่เข้ามาใหม่

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

AppState

void * AppState

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

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[อ่านอย่างเดียว] ออบเจ็กต์ผู้จัดการ Exchange

FabricState

const WeaveFabricState * FabricState

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

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

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

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

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

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

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

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

SendIdentifyRequest

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

ส่งข้อความ ContextRequest ไปยังที่อยู่ IP หนึ่งๆ

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

ส่งข้อความ identifierRequest ที่เผยแพร่เพื่อค้นหาโหนด Weave

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

ปิดการทำงาน

WEAVE_ERROR Shutdown(
  void
)

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

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

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