nl:: Wea:: Profil:: Penyediaan Jaringan:: Info Jaringan
#include <src/lib/profiles/network-provisioning/NetworkInfo.h>
Class utilitas untuk melakukan serialisasi dan deserialisasi payload yang dikomunikasikan melalui profil NetworkProvisioning: class ini mencakup informasi yang berkaitan dengan jaringan yang mendeteksi dan dikonfigurasi.
Ringkasan
Class ini bergantung pada penyimpanan menengah informasi penyediaan jaringan (antara penyimpanan akhir informasi dan payload jaringan) dan menggunakan pengelolaan memori dinamis untuk memberikan objek yang fleksibel runtime yang dihasilkan. Oleh karena itu, class ini tidak cocok untuk lingkungan yang paling terbatas, tetapi dapat digunakan di sistem yang lebih besar.
Konstruktor dan Destruktor |
|
---|---|
NetworkInfo()
|
|
~NetworkInfo()
|
Jenis publik |
|
---|---|
@210
|
enum |
@211
|
enum |
Atribut publik |
|
---|---|
Hidden
|
bool
Apakah jaringan disembunyikan atau tidak.
|
NetworkId
|
int64_t
ID jaringan yang ditetapkan pada jaringan oleh perangkat, -1 jika tidak ditentukan.
|
NetworkType
|
Jenis jaringan.
|
ThreadChannel
|
uint8_t
Saluran saat ini (saat ini [11..26]) tempat jaringan Thread beroperasi, atau kThreadChannel_NotSpecified.
|
ThreadExtendedPANId
|
uint8_t *
ID PAN yang diperluas Thread.
|
ThreadNetworkKey
|
uint8_t *
Kunci jaringan master Thread , atau NULL jika tidak ditentukan.
|
ThreadNetworkName
|
char *
Nama jaringan Thread, atau NULL jika tidak ditentukan.
|
ThreadPANId
|
uint32_t
ID PAN Thread 16-bit, atau kThreadPANId_NotSpecified.
|
ThreadPSKc
|
uint8_t *
Kunci yang dibagikan sebelumnya di thread untuk Commissioner, atau NULL jika tidak ditentukan.
|
WiFiKey
|
uint8_t *
Kunci Wi-Fi, atau NULL jika tidak ditentukan.
|
WiFiKeyLen
|
uint32_t
Panjang kunci WiFi dalam byte.
|
WiFiMode
|
Mode operasi jaringan Wi-Fi.
|
WiFiRole
|
Peran yang dimainkan oleh perangkat pada jaringan Wi-Fi.
|
WiFiSSID
|
char *
SSID Wi-Fi atau NULL jika tidak ditentukan.
|
WiFiSecurityType
|
Jenis keamanan Wi-Fi.
|
WirelessSignalStrength
|
int16_t
Kekuatan sinyal jaringan, atau INT16_MIN jika tidak tersedia/berlaku.
|
Fungsi publik |
|
---|---|
Clear(void)
|
void
Reset ke default dan kosongkan semua nilai dalam objek NetworkInfo ini.
|
CopyTo(NetworkInfo & dest)
|
Ganti konten objek NetworkInfo ini dengan salinan mendalam konten argumen.
|
Decode(nl::Weave::TLV::TLVReader & reader)
|
Lakukan deserialisasi konten objek NetworkInfo ini dari representasi TLV-nya.
|
Encode(nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const
|
Serial konten objek NetworkInfo ini ke dalam representasi TLV-nya.
|
MergeTo(NetworkInfo & dest)
|
Gabungkan konten objek NetworkInfo ini dengan salinan mendalam dari konten argumen.
|
Fungsi statis publik |
|
---|---|
DecodeList(nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)
|
Melakukan deserialisasi daftar elemen NetworkInfo dari representasi TLV-nya.
|
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)
|
Menserialisasikan array objek NetworkInfo menjadi representasi TLV-nya.
|
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount)
|
Lakukan serialisasi untuk array objek NetworkInfo menjadi representasi TLV-nya yang hanya memilih jaringan jenis tertentu.
|
Jenis publik
@210
@210
@211
@211
Atribut publik
Tersembunyi
bool Hidden
Apakah jaringan disembunyikan atau tidak.
ID Jaringan
int64_t NetworkId
ID jaringan yang ditetapkan pada jaringan oleh perangkat, -1 jika tidak ditentukan.
ThreadChannel
uint8_t ThreadChannel
Saluran saat ini (saat ini [11..26]) tempat jaringan Thread beroperasi, atau kThreadChannel_NotSpecified.
ThreadExtendedPANId
uint8_t * ThreadExtendedPANId
ID PAN yang diperluas Thread.
File ini adalah array yang terdiri dari 8 oktek yang dialokasikan secara dinamis, dimiliki oleh class. Dihancurkan pada kondisi apa pun yang memanggil Clear()
pada objek.
ThreadJaringanKunci
uint8_t * ThreadNetworkKey
Kunci jaringan master Thread , atau NULL jika tidak ditentukan.
Merupakan array oktet arbitrer yang dialokasikan secara dinamis, dimiliki oleh class yang Dihancurkan dalam kondisi apa pun yang memanggil Clear()
pada objek.
NamaThreadThread
char * ThreadNetworkName
Nama jaringan Thread, atau NULL jika tidak ditentukan.
Ini adalah C-string yang dihentikan NUL yang dihentikan secara dinamis, dimiliki oleh class. Dihancurkan pada kondisi apa pun yang memanggil Clear()
pada objek.
ID ThreadPANPAN
uint32_t ThreadPANId
ID PAN Thread 16-bit, atau kThreadPANId_NotSpecified.
ThreadPSKc
uint8_t * ThreadPSKc
Kunci yang dibagikan sebelumnya di thread untuk Commissioner, atau NULL jika tidak ditentukan.
Merupakan array oktet arbitrer yang dialokasikan secara dinamis, dimiliki oleh class yang Dihancurkan dalam kondisi apa pun yang memanggil Clear()
pada objek.
Kunci WiFi
uint8_t * WiFiKey
Kunci Wi-Fi, atau NULL jika tidak ditentukan.
File ini adalah array oktet arbitrer yang dialokasikan secara dinamis, dimiliki oleh class, dengan panjang yang ditentukan oleh WiFiKeyLen
. Dihancurkan pada kondisi apa pun yang memanggil Clear()
pada objek.
Wi-FiKeyLen
uint32_t WiFiKeyLen
Panjang kunci WiFi dalam byte.
Mode WiFi
::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode
Mode operasi jaringan Wi-Fi.
Peran WiFi
::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole
Peran yang dimainkan oleh perangkat pada jaringan Wi-Fi.
SSID Wi-Fi
char * WiFiSSID
SSID Wi-Fi atau NULL jika tidak ditentukan.
Ini adalah C-string yang dihentikan NUL yang dihentikan secara dinamis, dimiliki oleh class. Dihancurkan pada kondisi apa pun yang memanggil Clear()
pada objek.
JenisKeamananWi-Fi
::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType
Jenis keamanan Wi-Fi.
Kekuatan Sinyal Nirkabel
int16_t WirelessSignalStrength
Kekuatan sinyal jaringan, atau INT16_MIN jika tidak tersedia/berlaku.
Fungsi publik
SalinKe
WEAVE_ERROR CopyTo( NetworkInfo & dest )
Ganti konten objek NetworkInfo ini dengan salinan mendalam konten argumen.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Nilai yang Ditampilkan |
|
Dekode
WEAVE_ERROR Decode( nl::Weave::TLV::TLVReader & reader )
Lakukan deserialisasi konten objek NetworkInfo ini dari representasi TLV-nya.
Detail | |||
---|---|---|---|
Parameter |
|
||
Hasil |
WEAVE_NO_ERROR Jika berhasil, WEAVE_ERROR_INVALID_TLV_EST pada elemen apa pun yang tidak sesuai dengan profil penyediaan jaringan, error pembaca TLV apa pun pada decoding elemen yang salah.
|
Encoding
WEAVE_ERROR Encode( nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags ) const
Serial konten objek NetworkInfo ini ke dalam representasi TLV-nya.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Hasil |
WEAVE_NO_ERROR Jika berhasil, WEAVE_ERROR_INVALID_TLV_EST pada elemen apa pun yang tidak sesuai dengan profil penyediaan jaringan, error pembaca TLV apa pun pada decoding elemen yang salah.
|
GabungkanKe
WEAVE_ERROR MergeTo( NetworkInfo & dest )
Gabungkan konten objek NetworkInfo ini dengan salinan mendalam dari konten argumen.
Semua nilai non-default dari objek argumen akan menggantikan nilai dalam objek ini.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Nilai yang Ditampilkan |
|
Info Jaringan
NetworkInfo()
~InfoJaringan
~NetworkInfo()
Fungsi statis publik
DekodeDaftar
WEAVE_ERROR DecodeList( nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray )
Melakukan deserialisasi daftar elemen NetworkInfo dari representasi TLV-nya.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Nilai yang Ditampilkan |
|
DaftarEncode
WEAVE_ERROR EncodeList( nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags )
Menserialisasikan array objek NetworkInfo menjadi representasi TLV-nya.
Array akan menjadi elemen anonim dalam representasi TLV.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Nilai yang Ditampilkan |
|
DaftarEncode
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 )
Lakukan serialisasi untuk array objek NetworkInfo menjadi representasi TLV-nya yang hanya memilih jaringan jenis tertentu.
Detail | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||
Nilai yang Ditampilkan |
|