nl:: बुनें:: प्रोफाइल:: डिवाइस विवरण:: डिवाइस विवरण क्लाइंट

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

डिवाइस विवरण अनुरोध जारी करने के लिए क्लाइंट ऑब्जेक्ट।

सारांश

निर्माता और विनाशक De

DeviceDescriptionClient (void)

सार्वजनिक प्रकार

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) टाइपडीफ
void(*
यह फ़ंक्शन IdentityResponse संदेशों को संसाधित करने के लिए ज़िम्मेदार है।

सार्वजनिक गुण

AppState
void *
अनुप्रयोग परिभाषित राज्य वस्तु।
ExchangeMgr
[केवल पढ़ने के लिए] एक्सचेंज मैनेजर ऑब्जेक्ट
FabricState
[केवल पढ़ने के लिए] कपड़ा राज्य वस्तु
OnIdentifyResponseReceived

सार्वजनिक समारोह

CancelExchange (void)
प्रतिक्रिया की प्रतीक्षा कर रहे एक प्रगति पर पहचानकर्ता अनुरोध एक्सचेंज को रद्द करें।
Init ( WeaveExchangeManager *exchangeMgr)
डिवाइस विवरण क्लाइंट स्थिति प्रारंभ करें।
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
किसी विशेष आईपी पते पर एक पहचान अनुरोध संदेश भेजें।
SendIdentifyRequest (const IdentifyRequestMessage & msg)
वीव नोड्स को खोजने के लिए एक ब्रॉडकास्ट आइडेंटिफ़िकेशन रिक्वेस्ट मैसेज भेजें।
Shutdown (void)
डिवाइस विवरण क्लाइंट को शट डाउन करें।

सार्वजनिक प्रकार

हैंडल आइडेंटिफाई रेस्पॉन्स फंक्शन

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

यह फ़ंक्शन IdentityResponse संदेशों को संसाधित करने के लिए ज़िम्मेदार है।

विवरण
मापदंडों
[in] appState
IdentityRequest Exchange प्रसंग बनाते समय अनुप्रयोग परिभाषित स्थिति के लिए एक सूचक।
[in] nodeId
संदेश स्रोत की बुनाई नोड आईडी।
[in] nodeAddr
प्रतिसाद देने वाले नोड का IP पता.
[in] msg
आने वाले पहचान रिस्पांस संदेश का संदर्भ।

सार्वजनिक गुण

ऐपस्टेट

void * AppState

अनुप्रयोग परिभाषित राज्य वस्तु।

एक्सचेंजएमजीआर

WeaveExchangeManager * ExchangeMgr

[केवल पढ़ने के लिए] एक्सचेंज मैनेजर ऑब्जेक्ट

फैब्रिकस्टेट

const WeaveFabricState * FabricState

[केवल पढ़ने के लिए] कपड़ा राज्य वस्तु

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

सार्वजनिक समारोह

रद्द करेंएक्सचेंज

WEAVE_ERROR CancelExchange(
  void
)

प्रतिक्रिया की प्रतीक्षा कर रहे एक प्रगति पर पहचान अनुरोध एक्सचेंज को रद्द करें।

विवरण
वापसी मूल्य
WEAVE_NO_ERROR
बिना शर्त।

डिवाइस विवरण क्लाइंट

 DeviceDescriptionClient(
  void
)

में इस

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

डिवाइस विवरण क्लाइंट स्थिति प्रारंभ करें।

परम [इन] एक्सचेंजएमजीआर वीव एक्सचेंज मैनेजर के लिए एक सूचक।

विवरण
वापसी मूल्य
WEAVE_ERROR_INCORRECT_STATE
जब एक दूरस्थ निष्क्रिय मिलनसार सर्वर पहले ही पंजीकृत हो चुका हो।
WEAVE_NO_ERROR
सफलता पर।

SendIdentifyRequest

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

किसी विशेष आईपी पते पर एक पहचान अनुरोध संदेश भेजें।

विवरण
मापदंडों
[in] nodeAddr
क्वेरी के लिए वेव नोड के आईपी पते का संदर्भ।
[in] msg
भेजने के लिए पहचान अनुरोध संदेश का संदर्भ।
वापसी मूल्य
WEAVE_ERROR_NO_MEMORY
यदि पैकेट बफर का एक्सचेंज संदर्भ आवंटित करना विफल हो जाता है।
WEAVE_NO_ERROR
सफलता पर।
other
अन्य बुनाई या प्लेटफ़ॉर्म-विशिष्ट त्रुटि कोड यह दर्शाते हैं कि कोई त्रुटि हुई है जिससे पहचानकर्ता को भेजने से रोका जा रहा है।

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

वीव नोड्स को खोजने के लिए एक ब्रॉडकास्ट आइडेंटिफ़िकेशन रिक्वेस्ट मैसेज भेजें।

विवरण
मापदंडों
[in] msg
भेजने के लिए पहचान अनुरोध संदेश का संदर्भ।

शट डाउन

WEAVE_ERROR Shutdown(
  void
)

डिवाइस विवरण क्लाइंट को शट डाउन करें।

यह फ़ंक्शन किसी भी सक्रिय एक्सचेंज संदर्भ को बंद कर देता है और पॉइंटर्स को रीसेट करता है। वस्तु को फोन करके पुन: उपयोग किया जा सकता है Init विधि फिर से।

विवरण
वापसी मूल्य
WEAVE_NO_ERROR
बिना शर्त।