透過集合功能整理內容 你可以依據偏好儲存及分類內容。

nl::編織::設定檔:網路佈建::NetworkInfo

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

用於序列化和反序列化透過 Network 佈建 設定檔傳遞的公用程式類別:包含與偵測和設定網路相關的資訊。

摘要

這個類別使用中間儲存資訊的中繼儲存 (在資訊的最終存放區與網路酬載之間的中間),並使用動態記憶體管理來提供產生的物件彈性執行階段。因此,這個類別不適用於最嚴格的環境,但或許可用於大型系統。

建構函式和解構工具

NetworkInfo()
~NetworkInfo()

公開類型

@210 列舉
@211 列舉

公開屬性

Hidden
bool
是否隱藏網路。
NetworkId
int64_t
裝置指定的網路 ID。如果未指定,則為 -1。
NetworkType
網路類型。
ThreadChannel
uint8_t
執行緒網路的目前管道 (目前為 [11..26]),或 kThreadChannel_NotSpecified。
ThreadExtendedPANId
uint8_t *
Thread 擴充的 PAN ID。
ThreadNetworkKey
uint8_t *
Thread 主要網路金鑰 - 如未指定,則會傳回 NULL。
ThreadNetworkName
char *
Thread 網路的名稱,如未指定,則會傳回 NULL。
ThreadPANId
uint32_t
16 位元執行緒 PAN ID 或 kThreadPANId_NotSpecified。
ThreadPSKc
uint8_t *
為經銷商的執行緒預先共用金鑰;如未指定,則使用 NULL。
WiFiKey
uint8_t *
Wi-Fi 金鑰;如未指定,則會傳回 NULL。
WiFiKeyLen
uint32_t
Wi-Fi 金鑰的長度 (以位元組為單位)。
WiFiMode
Wi-Fi 網路的運作模式。
WiFiRole
裝置在 WiFi 網路上播放的角色。
WiFiSSID
char *
Wi-Fi SSID;如果未指定,則為 NULL。
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)
TLV 表示法反序列化 NetworkInfo 元素清單。
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

是否隱藏網路。

聯播網 ID

int64_t NetworkId

裝置指定的網路 ID。如果未指定,則為 -1。

NetworkType

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

網路類型。

ThreadChannel

uint8_t ThreadChannel

執行緒網路的目前管道 (目前為 [11..26]),或 kThreadChannel_NotSpecified。

ThreadExtendedPANId

uint8_t * ThreadExtendedPANId

Thread 擴充的 PAN ID。

是一組由 8 位元組組成的動態陣列,由類別擁有。已在物件上呼叫 Clear() 的任何條件下刪除。

ThreadNetwork 鍵

uint8_t * ThreadNetworkKey

Thread 主要網路金鑰 - 如未指定,則會傳回 NULL。

它是動態分配的任意八位元組陣列,由依物件上呼叫 Clear() 的條件所刪除。

執行緒網路

char * ThreadNetworkName

Thread 網路的名稱,如未指定,則會傳回 NULL。

這是由 NUL 終止、動態分配的 C 字串,由類別擁有。已在物件上呼叫 Clear() 的任何條件下刪除。

執行緒 ID

uint32_t ThreadPANId

16 位元執行緒 PAN ID 或 kThreadPANId_NotSpecified。

ThreadPSKc

uint8_t * ThreadPSKc

為經銷商的執行緒預先共用金鑰;如未指定,則使用 NULL。

它是動態分配的任意八位元組陣列,由依物件上呼叫 Clear() 的條件所刪除。

Wi-Fi 金鑰

uint8_t * WiFiKey

Wi-Fi 金鑰;如未指定,則會傳回 NULL。

這是由類別擁有的動態八元八元陣列,長度由 WiFiKeyLen 指定。已在物件上呼叫 Clear() 的任何條件下刪除。

Wi-Fi 鑰匙

uint32_t WiFiKeyLen

Wi-Fi 金鑰的長度 (以位元組為單位)。

Wi-Fi 模式

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

Wi-Fi 網路的運作模式。

WiFi 角色

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

裝置在 WiFi 網路上播放的角色。

WiFiSSID

char * WiFiSSID

Wi-Fi SSID;如果未指定,則為 NULL。

這是由 NUL 終止、動態分配的 C 字串,由類別擁有。已在物件上呼叫 Clear() 的任何條件下刪除。

Wi-Fi 安全性類型

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

Wi-Fi 安全性類型。

無線訊號強度

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
在平台不支援 malloc 或免費版時。
WEAVE_ERROR_NO_MEMORY
記憶體分配失敗。

解碼

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

將這個 NetworkInfo 物件的內容從 TLV 表示法反序列化。

詳情
參數
[in] reader
將 TLVReader 放置在包含網路資訊的結構元素中。
傳回

編碼

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

將這個 NetworkInfo 物件的內容序列化為 TLV 表示法。

詳情
參數
[in] writer
TLVWriter 位於物件序列化的位置。當這個物件是一陣列元素或 kTag_NetworkInformation 的設定檔標記,做為獨立元素發出時,函式會為這個物件發出匿名標記。
[in] encodeFlags
控制 NetworkInfo 憑證是否應序列化的旗標。
傳回

合併至

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

將這個 NetworkInfo 物件的內容與引數內容的深層連結合併。

引數物件中的所有非預設值都會取代這個物件中的值。

詳情
參數
[in] dest
NetworkInfo 物件,包含要複製到這個物件的資訊。
傳回值
WEAVE_NO_ERROR
上傳成功。
WEAVE_ERROR_NOT_IMPLEMENTED
在平台不支援 malloc 或免費版時。
WEAVE_ERROR_NO_MEMORY
記憶體分配失敗。

NetworkInfo

 NetworkInfo()

~網路資訊

 ~NetworkInfo()

公開的靜態函式

解碼清單

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

TLV 表示法反序列化 NetworkInfo 元素清單。

詳情
參數
[in] reader
TLVReader 放置在陣列起始位置。成功傳回時,寫入者會位於陣列的結尾。
[in,out] elemCount
輸入時,TTVReader 中要反序列化的元素數量上限。輸出內容時,實際上從串流反序列化的元素數量。
[in,out] elemArray
針對會包含反序列化 NetworkInfo 物件的 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() 函式傳回的錯誤。