nl::Weave::Profiles::NetworkProvisioning::NetworkInfo

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

NetworkProvisioning profili aracılığıyla iletilen yükü serileştirme ve serileştirmeye yönelik bir yardımcı program sınıfı: Ağların algılanması ve yapılandırılmasıyla ilgili bilgileri içerir.

Özet

Sınıf, ağ temel hazırlık bilgilerinin (bilgilerin nihai deposu ve ağ yükü arasındaki orta düzey) depolanmasını temel alır ve sonuçta elde edilen nesnenin esnek çalışma zamanını sağlamak için dinamik bellek yönetimini kullanır. Bu nedenle, bu sınıf kısıtlı ortamlar için uygun değildir ancak daha büyük sistemlerde kullanılabilir.

Oluşturucular ve Yıkıcılar
NetworkInfo()
~NetworkInfo()

Herkese açık türler
@210 enum
@211 enum

Herkese açık özellikler
Hidden
bool
Ağın gizlenmiş olup olmadığı.
NetworkId
int64_t
Ağa cihaz tarafından atanan ağ kimliği; belirtilmemişse -1.
NetworkType
Ağın türü.
ThreadChannel
uint8_t
İş parçacığı ağının çalıştığı geçerli kanal (şu anda [11..26]) veya kThreadChannel_NotSpecified.
ThreadExtendedPANId
uint8_t *
İleti dizisinde genişletilmiş PAN kimliği.
ThreadNetworkKey
uint8_t *
İş parçacığı ana ağ anahtarı veya belirtilmediyse NULL.
ThreadNetworkName
char *
İş parçacığı ağının adı veya belirtilmediyse NULL.
ThreadPANId
uint32_t
16 bit İş Parçacığı PAN Kimliği veya kThreadPANId_NotSpecified.
ThreadPSKc
uint8_t *
Komisyoncu için önceden paylaşılan anahtar veya belirtilmezse NULL ileti dizisi.
WiFiKey
uint8_t *
Kablosuz anahtarı veya belirtilmezse NULL değeri.
WiFiKeyLen
uint32_t
Kablosuz anahtarının bayt cinsinden uzunluğu.
WiFiMode
Kablosuz ağın çalışma modu.
WiFiRole
Cihazın kablosuz ağda oynadığı rol.
WiFiSSID
char *
Kablosuz SSID veya belirtilmemişse NULL.
WiFiSecurityType
Kablosuz ağ güvenlik türü.
WirelessSignalStrength
int16_t
Ağın sinyal gücü. Kullanılabilir değilse/geçerliyse INT16_MIN.

Kamu işlevleri
Clear(void)
void
Varsayılana sıfırlayın ve bu NetworkInfo nesnesindeki tüm değerleri serbest bırakın.
CopyTo(NetworkInfo & dest)
Bu NetworkInfo nesnesinin içeriğini, bağımsız değişkenin içeriğinin derin kopyasıyla değiştirin.
Decode(nl::Weave::TLV::TLVReader & reader)
Bu NetworkInfo nesnesinin içeriğini TLV temsilinden kaldırın.
Encode(nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const
Bu NetworkInfo nesnesinin içeriğini TLV gösterimi için seri hale getirin.
MergeTo(NetworkInfo & dest)
Bu NetworkInfo nesnesinin içeriğini, bağımsız değişkenin içeriğinin derin kopyasıyla birleştirin.

Herkese açık statik işlevler
DecodeList(nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)
NetworkInfo öğeleri listesini TLV gösteriminden seri durumdan çıkarın.
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)
NetworkInfo nesneleri dizisini TLV gösterimi için serileştirin.
EncodeList(nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, ::nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount)
Yalnızca belirli bir türdeki ağları seçerek NetworkInfo nesneleri dizisini TLV temsilinde serileştirin.

Herkese açık türler

@210

 @210

@211

 @211

Herkese açık özellikler

Gizli

bool Hidden

Ağın gizlenmiş olup olmadığı.

NetworkId

int64_t NetworkId

Ağa cihaz tarafından atanan ağ kimliği; belirtilmemişse -1.

NetworkType

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

Ağın türü.

ThreadChannel

uint8_t ThreadChannel

İş parçacığı ağının çalıştığı geçerli kanal (şu anda [11..26]) veya kThreadChannel_NotSpecified.

ThreadExtendedPANId

uint8_t * ThreadExtendedPANId

İleti dizisinde genişletilmiş PAN kimliği.

Sınıfa ait olan ve 8 sekizliklik dinamik olarak ayrılmış bir dizidir. Nesnede Clear() çağrısı yapan tüm koşullar için kaldırılır.

ThreadNetworkKey

uint8_t * ThreadNetworkKey

İş parçacığı ana ağ anahtarı veya belirtilmediyse NULL.

Nesnede Clear() çağrısı yapan herhangi bir koşulda Yok edilen sınıfında yer alan, dinamik olarak ayrılmış rastgele sekizliler dizisidir.

ThreadNetworkName

char * ThreadNetworkName

İş parçacığı ağının adı veya belirtilmediyse NULL.

NUL tarafından sonlandırılmış, dinamik olarak ayrılmış bir C-dizesidir ve sınıfa aittir. Nesnede Clear() çağrısı yapan tüm koşullar için kaldırılır.

ThreadPANId

uint32_t ThreadPANId

16 bit İş Parçacığı PAN Kimliği veya kThreadPANId_NotSpecified.

ThreadPSKc

uint8_t * ThreadPSKc

Komisyoncu için önceden paylaşılan anahtar veya belirtilmezse NULL ileti dizisi.

Nesnede Clear() çağrısı yapan herhangi bir koşulda Yok edilen sınıfında yer alan, dinamik olarak ayrılmış rastgele sekizliler dizisidir.

WiFiKey

uint8_t * WiFiKey

Kablosuz anahtarı veya belirtilmezse NULL değeri.

Sınıfın sahip olduğu ve uzunluğu WiFiKeyLen ile belirtilen, dinamik olarak ayrılmış rastgele sekizliler dizisidir. Nesnede Clear() çağrısı yapan tüm koşullar için kaldırılır.

WiFiKeyLen

uint32_t WiFiKeyLen

Kablosuz anahtarının bayt cinsinden uzunluğu.

WiFiMode

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

Kablosuz ağın çalışma modu.

WiFiRole

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

Cihazın kablosuz ağda oynadığı rol.

WiFiSSID

char * WiFiSSID

Kablosuz SSID veya belirtilmemişse NULL.

NUL tarafından sonlandırılmış, dinamik olarak ayrılmış bir C-dizesidir ve sınıfa aittir. Nesnede Clear() çağrısı yapan tüm koşullar için kaldırılır.

WiFiSecurityType

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

Kablosuz ağ güvenlik türü.

WirelessSignalStrength

int16_t WirelessSignalStrength

Ağın sinyal gücü. Kullanılabilir değilse/geçerliyse INT16_MIN.

Kamu işlevleri

Temizle

void Clear(
  void
)

Varsayılana sıfırlayın ve bu NetworkInfo nesnesindeki tüm değerleri serbest bırakın.

CopyTo

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

Bu NetworkInfo nesnesinin içeriğini, bağımsız değişkenin içeriğinin derin kopyasıyla değiştirin.

Ayrıntılar
Parametreler
[in] dest
Bu nesneye kopyalanacak bilgileri içeren NetworkInfo nesnesi.
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olun.
WEAVE_ERROR_NOT_IMPLEMENTED
Platform, Malloc veya free'yi desteklemediğinde.
WEAVE_ERROR_NO_MEMORY
Bellek ayırma hatalarında.

Decode

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

Bu NetworkInfo nesnesinin içeriğini TLV temsilinden kaldırın.

Ayrıntılar
Parametreler
[in] reader
TLVReader, ağ bilgilerini içeren yapı öğesine konumlandırıldı.
İadeler
WEAVE_NO_ERROR Başarılı olduğunda, ağ temel hazırlığı profiline uymayan herhangi bir öğede WEAVE_ERROR_INVALID_TLV_ELEMENT veya öğelerin kodunun yanlış çözülmesi sırasında TLV okuyucu hatalarından herhangi biri.

Kodla

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

Bu NetworkInfo nesnesinin içeriğini TLV gösterimi için seri hale getirin.

Ayrıntılar
Parametreler
[in] writer
TLVWriter, nesnenin serileştirileceği yere konumlandırılır. Bu nesne, bağımsız bir öğe olarak yayıldığında kTag_NetworkInformation için bir profil etiketi veya öğe dizisinin bir parçası olduğunda işlev bu nesne için anonim bir etiket yayınlar.
[in] encodeFlags
NetworkInfo kimlik bilgilerinin seri hale getirilip getirilmeyeceğini kontrol eden işaretler.
İadeler
WEAVE_NO_ERROR Başarılı olduğunda, ağ temel hazırlığı profiline uymayan herhangi bir öğede WEAVE_ERROR_INVALID_TLV_ELEMENT veya öğelerin kodunun yanlış çözülmesi sırasında TLV okuyucu hatalarından herhangi biri.

MergeTo

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

Bu NetworkInfo nesnesinin içeriğini, bağımsız değişkenin içeriğinin derin kopyasıyla birleştirin.

Bağımsız değişken nesnesindeki varsayılan olmayan tüm değerler, bu nesnedeki değerlerin yerine geçer.

Ayrıntılar
Parametreler
[in] dest
Bu nesneye kopyalanacak bilgileri içeren NetworkInfo nesnesi.
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olun.
WEAVE_ERROR_NOT_IMPLEMENTED
Platform, Malloc veya free'yi desteklemediğinde.
WEAVE_ERROR_NO_MEMORY
Bellek ayırma hatalarında.

NetworkInfo

 NetworkInfo()

~AğBilgileri

 ~NetworkInfo()

Herkese açık statik işlevler

DecodeList

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

NetworkInfo öğeleri listesini TLV gösteriminden seri durumdan çıkarın.

Ayrıntılar
Parametreler
[in] reader
TLVReader, dizi başlangıcına yerleştirildi. Başarılı bir dönüşte yazar, dizinin bitiminden sonra konumlandırılır.
[in,out] elemCount
Girişte, TLVReader'dan seri durumdan çıkarılacak maksimum öğe sayısı. Çıkışta, öğe sayısı akıştan fiilen seri durumdan çıkartılır.
[in,out] elemArray
Serileştirilmiş NetworkInfo nesnelerini içerecek NetworkInfo öğeleri dizisine başvuru. Dizi NULL olduğunda, aşağıdaki işlev tarafından dahili olarak ayrılır, aksi takdirde, harici olarak ayrılan dizinin en az elemCount nesnesi içerdiği varsayılır.
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olun.
WEAVE_ERROR_NOT_IMPLEMENTED
dinamik bellek yönetimini desteklemeyen platformlarda kullanılabilir.
other
Decode() işlevinden döndürülen hatalar.

EncodeList

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

NetworkInfo nesneleri dizisini TLV gösterimi için serileştirin.

Dizi, TLV gösteriminde anonim bir öğe olur.

Ayrıntılar
Parametreler
[in] writer
Uygun şekilde yerleştirilmiş TLVWriter
[in] elemCount
elemArray içindeki öğe sayısı.
[in] elemArray
Serileştirilecek NetworkInfo nesneleri dizisi.
[in] encodeFlags
NetworkInfo kimlik bilgilerinin seri hale getirilip getirilmeyeceğini kontrol eden işaretler.
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olun.
Other
Encode() işlevinden döndürülen hatalar.

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
)

Yalnızca belirli bir türdeki ağları seçerek NetworkInfo nesneleri dizisini TLV temsilinde serileştirin.

Ayrıntılar
Parametreler
[in] writer
Uygun şekilde yerleştirilmiş TLVWriter
[in] arrayLen
elemArray içindeki öğe sayısı.
[in] elemArray
Serileştirilecek NetworkInfo nesneleri dizisi.
[in] networkType
Serileştirilecek NetworkInfo nesnelerinin türü
[in] encodeFlags
NetworkInfo kimlik bilgilerinin seri hale getirilip getirilmeyeceğini kontrol eden işaretler.
[out] encodedElemCount
Gerçekte serileştirilmiş öğelerin sayısı.
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olun.
Other
Encode() işlevinden döndürülen hatalar.