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) टाइपडिफ़
void(*
इस फ़ंक्शन की मदद से IdentityResponse मैसेज को प्रोसेस किया जाता है.

सार्वजनिक विशेषताएं
AppState
void *
ऐप्लिकेशन की ओर से तय किए गए स्टेट ऑब्जेक्ट.
ExchangeMgr
[READ ONLY] Exchange मैनेजर ऑब्जेक्ट
FabricState
[READ ONLY] फ़ैब्रिक स्टेट ऑब्जेक्ट
OnIdentifyResponseReceived

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

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

HandleIdentifyResponseFunct

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

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

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

सार्वजनिक विशेषताएं

AppState

void * AppState

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

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[READ ONLY] Exchange मैनेजर ऑब्जेक्ट

FabricState

const WeaveFabricState * FabricState

[READ ONLY] फ़ैब्रिक स्टेट ऑब्जेक्ट

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

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

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

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

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

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

डिवाइस की जानकारी वाले क्लाइंट की स्थिति शुरू करें.

Weave Exchange Manager के लिए param[in] signMgr A पॉइंटर.

जानकारी
रिटर्न वैल्यू
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 नोड खोजने के लिए, एक ब्रॉडकास्ट IdentityRequest मैसेज भेजें.

जानकारी
पैरामीटर
[in] msg
भेजे जाने वाले IdentityRequest मैसेज का रेफ़रंस.

बंद करें

WEAVE_ERROR Shutdown(
  void
)

डिवाइस की जानकारी देने वाले क्लाइंट को बंद करें.

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

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