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 *
مفتاح الشبكة الرئيسي لسلسلة المحادثات ، أو NULL إذا لم يتم تحديده.
ThreadNetworkName
char *
اسم شبكة Thread أو "NULL" إذا لم يتم تحديده
ThreadPANId
uint32_t
رقم تعريف رقم الحساب الدائم (PAN) لسلسلة 16 بت أو kThreadPANId_NotSpecified.
ThreadPSKc
uint8_t *
مفتاح سلسلة المحادثات المشترك مسبقًا للمفوض، أو NULL إذا لم يتم تحديده.
WiFiKey
uint8_t *
مفتاح WiFi، أو NULL إذا لم يتم تحديده.
WiFiKeyLen
uint32_t
المدة بالبايت لمفتاح WiFi.
WiFiMode
وضع تشغيل شبكة Wi-Fi.
WiFiRole
الدور الذي يلعبه الجهاز على شبكة Wi-Fi.
WiFiSSID
char *
معرّف SSID لشبكة Wi-Fi أو NULL إذا لم يتم تحديده.
WiFiSecurityType
نوع أمان WiFi.
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 إذا لم يتم تحديده.

NetworkType

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

نوع الشبكة.

ThreadChannel

uint8_t ThreadChannel

القناة الحالية (حاليًا [11..26]) التي تعمل عليها شبكة Thread، أو kThreadChannel_NotSpecified.

ThreadExtendedPANId

uint8_t * ThreadExtendedPANId

رقم تعريف رقم الحساب الدائم (PAN) الموسّع في شبكة Thread

إنها مصفوفة مخصصة ديناميكيًا مكونة من 8 ثمانيات، تملكها الفئة. يتم إتلافه بسبب أي شرط يستدعي Clear() في العنصر.

ThreadNetworkKey

uint8_t * ThreadNetworkKey

مفتاح الشبكة الرئيسي لسلسلة المحادثات ، أو NULL إذا لم يتم تحديده.

هي مصفوفة مخصصة ديناميكيًا من ثماني بتات عشوائية تملكها الفئة "تم محوها" على أي شرط يستدعي Clear() في الكائن.

ThreadNetworkName

char * ThreadNetworkName

اسم شبكة Thread أو "NULL" إذا لم يتم تحديده

وهي سلسلة C-C منتهية الصلاحية والمخصصة ديناميكيًا والمملوكة للفئة. يتم إتلافه بسبب أي شرط يستدعي Clear() في العنصر.

ThreadPANId

uint32_t ThreadPANId

رقم تعريف رقم الحساب الدائم (PAN) لسلسلة 16 بت أو kThreadPANId_NotSpecified.

ThreadPSKc

uint8_t * ThreadPSKc

مفتاح سلسلة المحادثات المشترك مسبقًا للمفوض، أو NULL إذا لم يتم تحديده.

هي مصفوفة مخصصة ديناميكيًا من ثماني بتات عشوائية تملكها الفئة "تم محوها" على أي شرط يستدعي Clear() في الكائن.

WiFiKey

uint8_t * WiFiKey

مفتاح WiFi، أو NULL إذا لم يتم تحديده.

وهي عبارة عن مصفوفة مخصصة ديناميكيًا من ثماني بتات عشوائية تملكها فئة وتحددها السمة WiFiKeyLen. يتم إتلافه بسبب أي شرط يستدعي Clear() في العنصر.

WiFiKeyLen

uint32_t WiFiKeyLen

المدة بالبايت لمفتاح WiFi.

WiFiMode

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

وضع تشغيل شبكة Wi-Fi.

WiFiRole

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

الدور الذي يلعبه الجهاز على شبكة Wi-Fi.

WiFiSSID

char * WiFiSSID

معرّف SSID لشبكة Wi-Fi أو NULL إذا لم يتم تحديده.

وهي سلسلة C-تابعة للفئة NUL ومخصصة ديناميكيًا وتابعة للفئة. يتم إتلافه بسبب أي شرط يستدعي Clear() في العنصر.

WiFiSecurityType

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

نوع أمان WiFi.

WirelessSignalStrength

int16_t WirelessSignalStrength

قوة إشارة الشبكة أو INT16_MIN إذا لم تكن متاحة/منطبقة.

وظائف عامة

محو

void Clear(
  void
)

يُرجى إعادة الضبط على الإعدادات التلقائية وإخلاء جميع القيم داخل عنصر NetworkInfo هذا.

CopyTo

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

استبدِل محتوى كائن NetworkInfo هذا بالنسخة الخاصة بموضع محتوى الوسيطة.

التفاصيل
المعلمات
[in] dest
الكائن NetworkInfo الذي يحتوي على المعلومات المطلوب نسخها إلى هذا العنصر
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.
WEAVE_ERROR_NOT_IMPLEMENTED
إذا كانت المنصة لا توفّر إمكانية استخدام الحالة المركّبة أو المجانية
WEAVE_ERROR_NO_MEMORY
عند تعذُّر تخصيص الذاكرة

Decode

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

أزِل التسلسل من محتوى عنصر NetworkInfo هذا من تمثيل TLV الخاص به.

التفاصيل
المعلمات
[in] reader
يتم وضع TLVReader في عنصر البنية الذي يحتوي على معلومات الشبكة.
المرتجعات
WEAVE_NO_ERROR عند نجاح العملية، حدث WEAVE_ERROR_مرح_TLV_على أي عنصر لا يتوافق مع الملف الشخصي لتوفير المتطلبات اللازمة للشبكة، أو أي من أخطاء قارئ TLV عند فك ترميز العناصر بشكل غير صحيح.

ترميز

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

تسلسل محتوى عنصر NetworkInfo هذا في تمثيل TLV الخاص به

التفاصيل
المعلمات
[in] writer
يتم وضع TLVWriter في المكان الذي سيتم إنشاء الكائن فيه بشكل تسلسلي. تنبعث من الدالة علامة مجهولة المصدر لهذا الكائن عندما يكون هذا الكائن جزءًا من مصفوفة من العناصر أو علامة ملف شخصي لـ kTag_Network Information عندما يتم إطلاقه كعنصر مستقل.
[in] encodeFlags
العلامات التي تتحكم في ما إذا كان يجب أن تكون بيانات اعتماد NetworkInfo متسلسلة.
المرتجعات
WEAVE_NO_ERROR عند نجاح العملية، حدث WEAVE_ERROR_مرح_TLV_على أي عنصر لا يتوافق مع الملف الشخصي لتوفير المتطلبات اللازمة للشبكة، أو أي من أخطاء قارئ TLV عند فك ترميز العناصر بشكل غير صحيح.

MergeTo

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

ادمج محتوى الكائن NetworkInfo هذا مع النسخة التفصيلية لمحتوى الوسيطة.

يتم استبدال القيم غير التلقائية من كائن الوسيطة بالقيم في هذا الكائن.

التفاصيل
المعلمات
[in] dest
الكائن NetworkInfo الذي يحتوي على المعلومات المطلوب نسخها إلى هذا العنصر
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.
WEAVE_ERROR_NOT_IMPLEMENTED
إذا كانت المنصة لا توفّر إمكانية استخدام الحالة المركّبة أو المجانية
WEAVE_ERROR_NO_MEMORY
عند تعذُّر تخصيص الذاكرة

NetworkInfo

 NetworkInfo()

~NetworkInfo

 ~NetworkInfo()

الدوال الثابتة العامة

DecodeList

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

أزِل التسلسل الهرمي لقائمة عناصر NetworkInfo من تمثيل TLV الخاص بها.

التفاصيل
المعلمات
[in] reader
تحديد موضع TLVReader عند بداية الصفيف. عند الإرجاع الناجح، يتم وضع الكاتب بعد نهاية الصفيفة.
[in,out] elemCount
عند الإدخال، الحد الأقصى لعدد العناصر المطلوب إلغاء تسلسلها من TLVReader. عند الناتج، يتم إلغاء تسلسل العناصر بالفعل من ساحة المشاركات.
[in,out] elemArray
مرجع إلى مصفوفة عناصر NetworkInfo التي ستحتوي على كائنات NetworkInfo التي تم إلغاء تسلسلها عندما تكون الصفيفة فارغة، يتم تخصيصها داخليًا من خلال الدالة أدناه، وإلا فسيتم افتراض أن الصفيف المخصص خارجيًا يحتوي على عناصر elemCount على الأقل.
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.
WEAVE_ERROR_NOT_IMPLEMENTED
على الأنظمة الأساسية التي لا تتيح الإدارة الديناميكية للذاكرة.
other
الأخطاء التي نتجت عن الدالة Decode().

EncodeList

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().

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 الخاص بها مع اختيار شبكات من نوع معيّن فقط

التفاصيل
المعلمات
[in] writer
TLVWriter في المكان المناسب
[in] arrayLen
عدد العناصر في elemArray.
[in] elemArray
مصفوفة كائنات NetworkInfo المطلوب ترتيبها بشكل تسلسلي
[in] networkType
نوع كائنات NetworkInfo المراد إعدادها بشكل تسلسلي
[in] encodeFlags
العلامات التي تتحكم في ما إذا كان يجب أن تكون بيانات اعتماد NetworkInfo متسلسلة.
[out] encodedElemCount
يشير ذلك المصطلح إلى عدد العناصر المتسلسلة.
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.
Other
الأخطاء التي نتجت عن الدالة Encode().