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
[रीड ओनली] फ़ैब्रिक स्टेट ऑब्जेक्ट
OnIdentifyResponseReceived

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

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

HandleIdentifyResponseFunct

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

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

ब्यौरा
पैरामीटर
[in] appState
IdentityRequest एक्सचेंज कॉन्टेक्स्ट बनाते समय, ऐप्लिकेशन की तय की गई स्थिति का पॉइंटर.
[in] nodeId
मैसेज सोर्स का Weave नोड आईडी.
[in] nodeAddr
रिस्पॉन्स देने वाले नोड का आईपी पता.
[in] msg
आने वाले IdentityResponse मैसेज का रेफ़रंस.

सार्वजनिक एट्रिब्यूट

AppState

void * AppState

ऐप्लिकेशन की ओर से तय किया गया स्टेट ऑब्जेक्ट.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[रीड ओनली] Exchange मैनेजर ऑब्जेक्ट

FabricState

const WeaveFabricState * FabricState

[रीड ओनली] फ़ैब्रिक स्टेट ऑब्जेक्ट

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

सार्वजनिक फ़ंक्शन

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

जवाब के इंतज़ार में चल रहे IdentityRequest एक्सचेंज को रद्द करें.

ब्यौरा
रिटर्न वैल्यू
WEAVE_NO_ERROR
बिना किसी शर्त के.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

शुरू करें

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

डिवाइस का ब्यौरा क्लाइंट स्टेटस को शुरू करें.

Weave Exchange मैनेजर के लिए param[in] exchangeMgr एक पॉइंटर.

ब्यौरा
रिटर्न वैल्यू
WEAVE_ERROR_INCORRECT_STATE
जब रिमोट पैसिव रेज़र्वस सर्वर को पहले ही रजिस्टर किया जा चुका हो.
WEAVE_NO_ERROR
सफलता पर.

SendIdentifyRequest

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

किसी खास आईपी पते पर IdentityRequest मैसेज भेजें.

ब्यौरा
पैरामीटर
[in] nodeAddr
क्वेरी करने के लिए Weave नोड के आईपी पते का रेफ़रंस.
[in] msg
भेजने के लिए IdentityRequest मैसेज का रेफ़रंस.
रिटर्न वैल्यू
WEAVE_ERROR_NO_MEMORY
अगर पैकेट बफ़र का एक्सचेंज कॉन्टेक्स्ट तय नहीं हो पाता है, तो यह काम नहीं करेगा.
WEAVE_NO_ERROR
सफलता पर.
other
अन्य Weave या प्लैटफ़ॉर्म के हिसाब से गड़बड़ी के कोड से पता चलता है कि कोई ऐसी गड़बड़ी हुई है जिसकी वजह से IdentityRequest नहीं भेजा जा रहा है.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Weave नोड की खोज करने के लिए प्रसारण UniqueRequest मैसेज भेजें.

ब्यौरा
पैरामीटर
[in] msg
भेजने के लिए IdentityRequest मैसेज का रेफ़रंस.

बंद है

WEAVE_ERROR Shutdown(
  void
)

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

यह फ़ंक्शन किसी भी ऐक्टिव एक्सचेंज कॉन्टेक्स्ट को बंद कर देता है और पॉइंटर रीसेट करता है. Init तरीके का इस्तेमाल करके, इस ऑब्जेक्ट का फिर से इस्तेमाल किया जा सकता है.

ब्यौरा
रिटर्न वैल्यू
WEAVE_NO_ERROR
बिना किसी शर्त के.