nl:: Weave:: Profiles:: NetworkProvisioning:: NetworkInfo
#include <src/lib/profiles/network-provisioning/NetworkInfo.h>
فئة أداة لوضع تسلسل للحمولات التي يتم توصيلها عبر الملف الشخصي NetworkProvisioning وإلغاء تسلسلها: فهي تغلف المعلومات ذات الصلة برصد الشبكات وإعدادها.
ملخّص
تعتمد الفئة على التخزين المتوسط لمعلومات توفير الشبكة (المتوسط بين المخزن النهائي للمعلومات وحمولة الشبكة) وتستخدم إدارة الذاكرة الديناميكية لمنح العنصر وقت تشغيل مرنًا. وبالتالي، لا يمكن استخدام هذه الفئة مع البيئات الأكثر تقييدًا، ولكن يمكن استخدامها على الأنظمة الأكبر حجمًا.
الدلالة والهياكل |
|
---|---|
NetworkInfo()
|
|
~NetworkInfo()
|
الأنواع العلنية |
|
---|---|
@210
|
تعداد |
@211
|
تعداد |
السمات العامة |
|
---|---|
Hidden
|
bool
تحديد ما إذا كانت الشبكة مخفية أم لا.
|
NetworkId
|
int64_t
رقم تعريف الشبكة الذي تم تعيينه للشبكة من خلال الجهاز، 1- إذا لم يتم تحديده.
|
NetworkType
|
نوع الشبكة.
|
ThreadChannel
|
uint8_t
القناة الحالية (حاليًا [11..26]) التي تعمل عليها شبكة Thread أو kThreadChannel_NotSpecified.
|
ThreadExtendedPANId
|
uint8_t *
رقم تعريف PAN الموسَّع في Thread.
|
ThreadNetworkKey
|
uint8_t *
مفتاح شبكة Thread الرئيسية أو NULL إذا لم يتم تحديده.
|
ThreadNetworkName
|
char *
اسم شبكة Thread، أو NULL إذا لم يتم تحديده.
|
ThreadPANId
|
uint32_t
رقم تعريف PAN في سلسلة Thread (16 بت) أو kThreadPANId_NotSpecified
|
ThreadPSKc
|
uint8_t *
مفتاح مشترك مسبقًا لسلسلة المحادثات للمفوَّض أو فارغ في حال عدم تحديده
|
WiFiKey
|
uint8_t *
مفتاح Wi-Fi أو "فارغ" إذا لم يتم تحديده.
|
WiFiKeyLen
|
uint32_t
طول مفتاح Wi-Fi بالبايت.
|
WiFiMode
|
وضع تشغيل شبكة Wi-Fi.
|
WiFiRole
|
الدور الذي يلعبه الجهاز على شبكة Wi-Fi.
|
WiFiSSID
|
char *
معرِّف SSID لشبكة Wi-Fi أو فارغ في حال عدم تحديده.
|
WiFiSecurityType
|
نوع أمان شبكة Wi-Fi
|
WirelessSignalStrength
|
int16_t
قوة إشارة الشبكة، أو INT16_MIN إذا لم تكن متاحة/منطبقة.
|
الدوال العامة |
|
---|---|
Clear(void)
|
void
يمكنك إعادة الضبط على القيمة التلقائية وإخلاء بعض القيم في عنصر NetworkInfo هذا.
|
CopyTo(NetworkInfo & dest)
|
استبدِل محتوى الكائن NetworkInfo هذا بالنسخة لصفحة في التطبيق من محتوى الوسيطة.
|
Decode(nl::Weave::TLV::TLVReader & reader)
|
اطّلِع على محتوى عنصر 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)
|
عليك الاطّلاع على قائمة بعناصر 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
تحديد ما إذا كانت الشبكة مخفية أم لا.
NetworkId
int64_t NetworkId
رقم تعريف الشبكة الذي تم تعيينه للشبكة من خلال الجهاز، 1- إذا لم يتم تحديده.
ThreadChannel
uint8_t ThreadChannel
القناة الحالية (حاليًا [11..26]) التي تعمل عليها شبكة Thread أو kThreadChannel_NotSpecified.
ThreadExtendedPANId
uint8_t * ThreadExtendedPANId
رقم تعريف PAN الموسَّع في Thread.
وهي صفيف مخصص ديناميكيًا مكون من 8 ثُمانيات، تملكها الفئة. يتم محوها في أي شرط يستدعي Clear()
في العنصر.
ThreadNetworkKey
uint8_t * ThreadNetworkKey
مفتاح شبكة Thread الرئيسية أو NULL إذا لم يتم تحديده.
هي مصفوفة مخصّصة ديناميكيًا من الثمانيات العشوائية، تمتلكها الفئة Destroyed على أي شرط يستدعي Clear()
في الكائن.
ThreadNetworkName
char * ThreadNetworkName
اسم شبكة Thread، أو NULL إذا لم يتم تحديده.
إنها سلسلة C تم إنهاؤها فارغة، ومخصصة ديناميكيًا، ومملوكة للفئة. يتم محوها في أي شرط يستدعي Clear()
في العنصر.
ThreadPANId
uint32_t ThreadPANId
رقم تعريف PAN في سلسلة Thread (16 بت) أو kThreadPANId_NotSpecified
ThreadPSKc
uint8_t * ThreadPSKc
مفتاح مشترك مسبقًا لسلسلة المحادثات للمفوَّض أو فارغ في حال عدم تحديده
هي مصفوفة مخصّصة ديناميكيًا من الثمانيات العشوائية، تمتلكها الفئة Destroyed على أي شرط يستدعي Clear()
في الكائن.
WiFiKey
uint8_t * WiFiKey
مفتاح Wi-Fi أو "فارغ" إذا لم يتم تحديده.
هي مصفوفة مخصّصة ديناميكيًا من الثمانيات العشوائية التي تمتلكها الفئة، مع تحديد طولها في WiFiKeyLen
. يتم محوها في أي شرط يستدعي Clear()
في العنصر.
WiFiKeyLen
uint32_t WiFiKeyLen
طول مفتاح Wi-Fi بالبايت.
WiFiRole
::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole
الدور الذي يلعبه الجهاز على شبكة Wi-Fi.
WiFiSSID
char * WiFiSSID
معرِّف SSID لشبكة Wi-Fi أو فارغ في حال عدم تحديده.
إنها سلسلة C تم إنهاؤها فارغة، ومخصصة ديناميكيًا، ومملوكة للفئة. يتم محوها في أي شرط يستدعي Clear()
في العنصر.
WiFiSecurityType
::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType
نوع أمان شبكة Wi-Fi
WirelessSignalStrength
int16_t WirelessSignalStrength
قوة إشارة الشبكة، أو INT16_MIN إذا لم تكن متاحة/منطبقة.
الدوال العامة
محو
void Clear( void )
يمكنك إعادة الضبط على القيمة التلقائية وإخلاء بعض القيم في عنصر NetworkInfo هذا.
CopyTo
WEAVE_ERROR CopyTo( NetworkInfo & dest )
استبدِل محتوى الكائن NetworkInfo هذا بالنسخة لصفحة في التطبيق من محتوى الوسيطة.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
Decode
WEAVE_ERROR Decode( nl::Weave::TLV::TLVReader & reader )
اطّلِع على محتوى عنصر NetworkInfo هذا من تمثيل TLV.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
WEAVE_NO_ERROR عند اكتمال العملية بنجاح، يظهر WEAVE_ERROR_INVALID_TLV_ELEMENT على أي عنصر لا يتوافق مع الملف الشخصي لإدارة الشبكة، وأي من أخطاء قارئ TLV عند فك ترميز العناصر بشكل غير صحيح.
|
الترميز
WEAVE_ERROR Encode( nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags ) const
أدخِل سلسلة محتوى عنصر NetworkInfo هذا في تمثيل TLV الخاص به.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
||||
المرتجعات |
WEAVE_NO_ERROR عند اكتمال العملية بنجاح، يظهر WEAVE_ERROR_INVALID_TLV_ELEMENT على أي عنصر لا يتوافق مع الملف الشخصي لإدارة الشبكة، وأي من أخطاء قارئ TLV عند فك ترميز العناصر بشكل غير صحيح.
|
MergeTo
WEAVE_ERROR MergeTo( NetworkInfo & dest )
ادمج محتوى عنصر NetworkInfo هذا مع النسخة العميقة من محتوى الوسيطة.
تستبدل جميع القيم غير التلقائية من كائن الوسيطة القيم الموجودة في هذا الكائن.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
NetworkInfo
NetworkInfo()
~NetworkInfo
~NetworkInfo()
الدوال الثابتة العامة
DecodeList
WEAVE_ERROR DecodeList( nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray )
عليك الاطّلاع على قائمة بعناصر NetworkInfo من تمثيل TLV.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
EncodeList
WEAVE_ERROR EncodeList( nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags )
أدخِل سلسلة من عناصر NetworkInfo في تمثيل TLV.
ستكون الصفيفة عنصرًا مجهولاً في تمثيل TLV.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
EncodeList
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 مع اختيار شبكات من نوع معيّن فقط.
التفاصيل | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||||||
قيم الإرجاع |
|