nl:: बुनें:: प्रोफाइल:: नेटवर्कप्रोविजनिंग:: नेटवर्क जानकारी

#include <src/lib/profiles/network-provisioning/NetworkInfo.h>

Serializing और के माध्यम से भेजी पेलोड deserializing के लिए एक उपयोगिता वर्ग NetworkProvisioning प्रोफाइल: यह पता लगाने और को विन्यस्त नेटवर्क के लिए जानकारी प्रासंगिक समाहित।

सारांश

वर्ग नेटवर्क प्रावधान जानकारी (सूचना के अंतिम स्टोर और नेटवर्क पेलोड के बीच मध्यवर्ती) के मध्यवर्ती भंडारण पर निर्भर करता है और परिणामी वस्तु को लचीला रनटाइम देने के लिए गतिशील स्मृति प्रबंधन का उपयोग करता है। जैसे, यह वर्ग सबसे विवश वातावरण के लिए उपयुक्त नहीं है, लेकिन इसका उपयोग बड़े सिस्टम पर किया जा सकता है।

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

NetworkInfo ()
~NetworkInfo ()

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

@210 एन्यूम
@211 एन्यूम

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

Hidden
bool
नेटवर्क छिपा हुआ है या नहीं।
NetworkId
int64_t
डिवाइस द्वारा नेटवर्क को असाइन किया गया नेटवर्क आईडी, -1 यदि निर्दिष्ट नहीं है।
NetworkType
नेटवर्क का प्रकार।
ThreadChannel
uint8_t
वर्तमान चैनल (वर्तमान में [11..26]) जिस पर थ्रेड नेटवर्क संचालित होता है, या kThreadChannel_NotSpecified।
ThreadExtendedPANId
uint8_t *
थ्रेड विस्तारित पैन आईडी।
ThreadNetworkKey
uint8_t *
थ्रेड मास्टर नेटवर्क कुंजी , या NULL यदि निर्दिष्ट नहीं है।
ThreadNetworkName
char *
थ्रेड नेटवर्क का नाम, या निर्दिष्ट नहीं होने पर NULL।
ThreadPANId
uint32_t
16-बिट थ्रेड पैन आईडी, या kThreadPANId_Notनिर्दिष्ट।
ThreadPSKc
uint8_t *
आयुक्त के लिए पूर्व-साझा कुंजी को थ्रेड करें, या निर्दिष्ट नहीं होने पर NULL।
WiFiKey
uint8_t *
वाईफाई कुंजी, या NULL यदि निर्दिष्ट नहीं है।
WiFiKeyLen
uint32_t
वाईफाई कुंजी के बाइट्स में लंबाई।
WiFiMode
वाईफाई नेटवर्क का ऑपरेटिंग मोड।
WiFiRole
वाईफाई नेटवर्क पर डिवाइस द्वारा निभाई गई भूमिका।
WiFiSSID
char *
वाईफाई SSID, या NULL यदि निर्दिष्ट नहीं है।
WiFiSecurityType
वाईफाई सुरक्षा प्रकार।
WirelessSignalStrength
int16_t
नेटवर्क की सिग्नल शक्ति, या INT16_MIN यदि उपलब्ध/लागू नहीं है।

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

Clear (void)
void
इस के भीतर लागू हो और सभी मूल्यों को मुक्त करने के रीसेट NetworkInfo वस्तु।
CopyTo ( NetworkInfo & dest)
इस की सामग्री को बदलने NetworkInfo तर्क की सामग्री की गहरी प्रति के साथ वस्तु।
Decode (nl::Weave::TLV::TLVReader & reader)
इस की सामग्री deserialize NetworkInfo अपने से वस्तु TLV प्रतिनिधित्व।
Encode (nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const
इस की सामग्री को क्रमानुसार NetworkInfo अपने में वस्तु TLV प्रतिनिधित्व।
MergeTo ( NetworkInfo & dest)
इस की सामग्री को मर्ज NetworkInfo तर्क की सामग्री की गहरी प्रति के साथ वस्तु।

सार्वजनिक स्थैतिक कार्य

DecodeList (nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)
की एक सूची deserialize NetworkInfo अपने से तत्वों TLV प्रतिनिधित्व।
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)
क्रमानुसार की एक सरणी NetworkInfo अपने में वस्तुओं TLV प्रतिनिधित्व।
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, :: nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount)
क्रमानुसार की एक सरणी NetworkInfo अपने में वस्तुओं TLV एक विशेष प्रकार के केवल नेटवर्क का चयन प्रतिनिधित्व।

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

@210

 @210

@211

 @211

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

छिपा हुआ

bool Hidden

नेटवर्क छिपा हुआ है या नहीं।

नेटवर्क आईडी

int64_t NetworkId

डिवाइस द्वारा नेटवर्क को असाइन किया गया नेटवर्क आईडी, -1 यदि निर्दिष्ट नहीं है।

नेटवर्क प्रकार

::nl::Weave::Profiles::NetworkProvisioning::NetworkType NetworkType

नेटवर्क का प्रकार।

थ्रेड चैनल

uint8_t ThreadChannel

वर्तमान चैनल (वर्तमान में [11..26]) जिस पर थ्रेड नेटवर्क संचालित होता है, या kThreadChannel_NotSpecified।

थ्रेडविस्तारितपैनआईडी

uint8_t * ThreadExtendedPANId

थ्रेड विस्तारित पैन आईडी।

यह कक्षा के स्वामित्व वाले 8 ऑक्टेक्ट्स की गतिशील रूप से आवंटित सरणी है। किसी भी शर्त यह है कि कॉल पर नष्ट कर दिया Clear() वस्तु पर।

थ्रेडनेटवर्ककी

uint8_t * ThreadNetworkKey

थ्रेड मास्टर नेटवर्क कुंजी , या NULL यदि निर्दिष्ट नहीं है।

यह मनमाना ओक्टेट्स की गतिशील आवंटित सरणी, वर्ग किसी भी शर्त पर नष्ट कर दिया है कि कॉल के स्वामित्व में है Clear() वस्तु पर।

थ्रेडनेटवर्कनाम

char * ThreadNetworkName

थ्रेड नेटवर्क का नाम, या NULL यदि निर्दिष्ट नहीं है।

यह एक एनयूएल-समाप्त, गतिशील रूप से आवंटित सी-स्ट्रिंग है, जो वर्ग के स्वामित्व में है। किसी भी शर्त यह है कि कॉल पर नष्ट कर दिया Clear() वस्तु पर।

थ्रेडपैनआईडी

uint32_t ThreadPANId

16-बिट थ्रेड पैन आईडी, या kThreadPANId_Notनिर्दिष्ट।

थ्रेडपीएसकेसी

uint8_t * ThreadPSKc

आयुक्त के लिए पूर्व-साझा कुंजी को थ्रेड करें, या निर्दिष्ट नहीं होने पर NULL।

यह मनमाना ओक्टेट्स की गतिशील आवंटित सरणी, वर्ग किसी भी शर्त पर नष्ट कर दिया है कि कॉल के स्वामित्व में है Clear() वस्तु पर।

वाईफाईकी

uint8_t * WiFiKey

वाईफाई कुंजी, या NULL यदि निर्दिष्ट नहीं है।

यह मनमाना ओक्टेट्स की गतिशील आवंटित सरणी, द्वारा निर्दिष्ट लंबाई के साथ वर्ग के स्वामित्व में है, WiFiKeyLen । किसी भी शर्त यह है कि कॉल पर नष्ट कर दिया Clear() वस्तु पर।

वाईफाईकेलेन

uint32_t WiFiKeyLen

वाईफाई कुंजी के बाइट्स में लंबाई।

वाईफाईमोड

::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode

वाईफाई नेटवर्क का ऑपरेटिंग मोड।

वाईफाईभूमिका

::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole

वाईफाई नेटवर्क पर डिवाइस द्वारा निभाई गई भूमिका।

वाईफाईएसएसआईडी

char * WiFiSSID

वाईफाई SSID, या NULL यदि निर्दिष्ट नहीं है।

यह एक एनयूएल-समाप्त, गतिशील रूप से आवंटित सी-स्ट्रिंग है, जो वर्ग के स्वामित्व में है। किसी भी शर्त यह है कि कॉल पर नष्ट कर दिया Clear() वस्तु पर।

वाईफाई सुरक्षा प्रकार

::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType

वाईफाई सुरक्षा प्रकार।

वायरलेस सिग्नल शक्ति

int16_t WirelessSignalStrength

नेटवर्क की सिग्नल शक्ति, या INT16_MIN यदि उपलब्ध/लागू नहीं है।

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

स्पष्ट

void Clear(
  void
)

इस के भीतर लागू हो और सभी मूल्यों को मुक्त करने के रीसेट NetworkInfo वस्तु।

को कॉपी

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

इस की सामग्री को बदलने NetworkInfo तर्क की सामग्री की गहरी प्रति के साथ वस्तु।

विवरण
मापदंडों
[in] dest
NetworkInfo जानकारी युक्त वस्तु इस वस्तु में कॉपी कर सकते हैं।
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
WEAVE_ERROR_NOT_IMPLEMENTED
जब प्लेटफ़ॉर्म मॉलोक या फ्री का समर्थन नहीं करता है।
WEAVE_ERROR_NO_MEMORY
स्मृति आवंटन विफलताओं पर।

व्याख्या करना

WEAVE_ERROR Decode(
  nl::Weave::TLV::TLVReader & reader
)

इस की सामग्री deserialize NetworkInfo अपने से वस्तु TLV प्रतिनिधित्व।

विवरण
मापदंडों
[in] reader
TLVReader नेटवर्क जानकारी वाले संरचना तत्व पर स्थित है।
रिटर्न
WEAVE_NO_ERROR पर सफलता, किसी भी तत्व नेटवर्क प्रावधानीकरण प्रोफ़ाइल, में से किसी के अनुरूप नहीं पर WEAVE_ERROR_INVALID_TLV_ELEMENT TLV तत्वों के गलत डिकोडिंग पर पाठक त्रुटियों।

एन्कोड

WEAVE_ERROR Encode(
  nl::Weave::TLV::TLVWriter & writer,
  uint8_t encodeFlags
) const 

इस की सामग्री को क्रमानुसार NetworkInfo अपने में वस्तु TLV प्रतिनिधित्व।

विवरण
मापदंडों
[in] writer
TLVWriter उस स्थान पर स्थित है जहां ऑब्जेक्ट को क्रमबद्ध किया जाएगा। फ़ंक्शन इस ऑब्जेक्ट के लिए एक अनाम टैग उत्सर्जित करता है जब यह ऑब्जेक्ट तत्वों की सरणी का हिस्सा होता है या एक स्टैंडअलोन तत्व के रूप में उत्सर्जित होने पर kTag_NetworkInformation के लिए प्रोफ़ाइल टैग होता है।
[in] encodeFlags
झंडे को नियंत्रित करने के लिए कि क्या की साख NetworkInfo श्रृंखलाबद्ध किया जाना चाहिए।
रिटर्न
WEAVE_NO_ERROR पर सफलता, किसी भी तत्व नेटवर्क प्रावधानीकरण प्रोफ़ाइल, में से किसी के अनुरूप नहीं पर WEAVE_ERROR_INVALID_TLV_ELEMENT TLV तत्वों के गलत डिकोडिंग पर पाठक त्रुटियों।

मर्ज टू

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

इस की सामग्री को मर्ज NetworkInfo तर्क की सामग्री की गहरी प्रति के साथ वस्तु।

तर्क ऑब्जेक्ट से सभी गैर-डिफ़ॉल्ट मान इस ऑब्जेक्ट में मानों को प्रतिस्थापित करते हैं।

विवरण
मापदंडों
[in] dest
NetworkInfo जानकारी युक्त वस्तु इस वस्तु में कॉपी कर सकते हैं।
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
WEAVE_ERROR_NOT_IMPLEMENTED
जब प्लेटफ़ॉर्म मॉलोक या फ्री का समर्थन नहीं करता है।
WEAVE_ERROR_NO_MEMORY
स्मृति आवंटन विफलताओं पर।

नेटवर्क जानकारी

 NetworkInfo()

~नेटवर्कइन्फो

 ~NetworkInfo()

सार्वजनिक स्थैतिक कार्य

डिकोड सूची

WEAVE_ERROR DecodeList(
  nl::Weave::TLV::TLVReader & reader,
  uint16_t & elemCount,
  NetworkInfo *& elemArray
)

की एक सूची deserialize NetworkInfo अपने से तत्वों TLV प्रतिनिधित्व।

विवरण
मापदंडों
[in] reader
TLVReader सरणी प्रारंभ में स्थित है। सफल वापसी पर, लेखक सरणी के अंत के बाद स्थित होता है।
[in,out] elemCount
इनपुट पर, TLVReader से डिसेरिएलाइज़ करने के लिए तत्वों की अधिकतम संख्या। आउटपुट पर, तत्वों की संख्या वास्तव में धारा से deserialized।
[in,out] elemArray
की सरणी का संदर्भ NetworkInfo तत्वों कि deserialized शामिल होंगे NetworkInfo वस्तुओं। जब सरणी NULL होती है, तो इसे नीचे दिए गए फ़ंक्शन द्वारा आंतरिक रूप से आवंटित किया जाता है, अन्यथा यह माना जाता है कि बाहरी रूप से आवंटित सरणी में कम से कम elemCount ऑब्जेक्ट हैं।
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
WEAVE_ERROR_NOT_IMPLEMENTED
उन प्लेटफार्मों पर जो गतिशील स्मृति प्रबंधन का समर्थन नहीं करते हैं।
other
त्रुटियाँ से लौटे Decode() समारोह।

एनकोड सूची

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t elemCount,
  const NetworkInfo *elemArray,
  uint8_t encodeFlags
)

क्रमानुसार की एक सरणी NetworkInfo अपने में वस्तुओं TLV प्रतिनिधित्व।

सरणी में एक गुमनाम तत्व हो जाएगा TLV प्रतिनिधित्व।

विवरण
मापदंडों
[in] writer
उचित रूप से तैनात TLVWriter
[in] elemCount
में तत्वों की संख्या elemArray
[in] elemArray
की सरणी NetworkInfo धारावाहिक जा करने के लिए वस्तुओं।
[in] encodeFlags
झंडे को नियंत्रित करने के लिए कि क्या की साख NetworkInfo श्रृंखलाबद्ध किया जाना चाहिए।
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
Other
त्रुटियाँ से लौटे Encode() समारोह।

एनकोड सूची

WEAVE_ERROR EncodeList(
  nl::Weave::TLV::TLVWriter & writer,
  uint16_t arrayLen,
  const NetworkInfo *elemArray,
  ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType,
  uint8_t encodeFlags,
  uint16_t & encodedElemCount
)

क्रमानुसार की एक सरणी NetworkInfo अपने में वस्तुओं TLV एक विशेष प्रकार के केवल नेटवर्क का चयन प्रतिनिधित्व।

विवरण
मापदंडों
[in] writer
उचित रूप से तैनात TLVWriter
[in] arrayLen
में तत्वों की संख्या elemArray
[in] elemArray
की सरणी NetworkInfo धारावाहिक जा करने के लिए वस्तुओं।
[in] networkType
के प्रकार NetworkInfo क्रमानुसार करने वस्तुओं
[in] encodeFlags
झंडे को नियंत्रित करने के लिए कि क्या की साख NetworkInfo श्रृंखलाबद्ध किया जाना चाहिए।
[out] encodedElemCount
वास्तव में क्रमबद्ध तत्वों की संख्या।
वापसी मूल्य
WEAVE_NO_ERROR
सफलता पर।
Other
त्रुटियाँ से लौटे Encode() समारोह।