nl :: Dệt :: Hồ sơ :: Quản lý mạng :: Thông tin mạng
#include <src/lib/profiles/network-provisioning/NetworkInfo.h>
Một lớp tiện ích cho serializing và deserializing trọng tải thông qua NetworkProvisioning hồ sơ: nó đóng gói thích hợp thông tin cho mạng phát hiện và cấu hình.
Tóm lược
Lớp dựa trên việc lưu trữ trung gian thông tin cung cấp mạng (trung gian giữa kho lưu trữ thông tin cuối cùng và trọng tải mạng) và sử dụng quản lý bộ nhớ động để cung cấp cho đối tượng kết quả thời gian chạy linh hoạt. Do đó, lớp này không phù hợp với các môi trường hạn chế nhất, nhưng có thể được sử dụng trên các hệ thống lớn hơn.
Người xây dựng và Người phá hủy | |
---|---|
NetworkInfo () | |
~NetworkInfo () |
Các loại công khai | |
---|---|
@210 | enum |
@211 | enum |
Thuộc tính công cộng | |
---|---|
Hidden | bool Mạng có bị ẩn hay không. |
NetworkId | int64_t Id mạng được thiết bị gán cho mạng, -1 nếu không được chỉ định. |
NetworkType | Loại mạng. |
ThreadChannel | uint8_t Kênh hiện tại (hiện tại là [11..26]) mà mạng Thread hoạt động, hoặc kThreadChannel_NotSpecified. |
ThreadExtendedPANId | uint8_t * ID PAN mở rộng của Chủ đề. |
ThreadNetworkKey | uint8_t * Khóa mạng chính của Chủ đề hoặc NULL nếu không được chỉ định. |
ThreadNetworkName | char * Tên của mạng Chủ đề hoặc NULL nếu không được chỉ định. |
ThreadPANId | uint32_t ID PAN luồng 16 bit hoặc kThreadPANId_NotSpecified. |
ThreadPSKc | uint8_t * Khóa chia sẻ trước chủ đề cho ủy viên, hoặc NULL nếu không được chỉ định. |
WiFiKey | uint8_t * Khóa WiFi hoặc NULL nếu không được chỉ định. |
WiFiKeyLen | uint32_t Độ dài tính bằng byte của khóa WiFi. |
WiFiMode | Chế độ hoạt động của mạng WiFi. |
WiFiRole | Vai trò của thiết bị trên mạng WiFi. |
WiFiSSID | char * SSID WiFi hoặc NULL nếu không được chỉ định. |
WiFiSecurityType | Loại bảo mật WiFi. |
WirelessSignalStrength | int16_t Cường độ tín hiệu của mạng hoặc INT16_MIN nếu không khả dụng / có thể áp dụng. |
Chức năng công cộng | |
---|---|
Clear (void) | void Thiết lập lại để mặc định và giải phóng tất cả các giá trị trong phạm vi này NetworkInfo đối tượng. |
CopyTo ( NetworkInfo & dest) | Thay thế nội dung này NetworkInfo đối tượng với các bản sao sâu sắc về nội dung của các cuộc tranh cãi. |
Decode (nl::Weave::TLV::TLVReader & reader) | Deserialize nội dung này NetworkInfo đối tượng từ nó TLV đại diện. |
Encode (nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const | Serialize nội dung này NetworkInfo đối tượng vào nó TLV đại diện. |
MergeTo ( NetworkInfo & dest) | Hợp nhất các nội dung này NetworkInfo đối tượng với các bản sao sâu sắc về nội dung của các cuộc tranh cãi. |
Các chức năng tĩnh công khai | |
---|---|
DecodeList (nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray) | Deserialize một danh sách các NetworkInfo yếu tố từ nó TLV đại diện. |
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags) | Serialize một mảng của NetworkInfo đối tượng vào nó TLV đại diện. |
EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t arrayLen, const NetworkInfo *elemArray, :: nl::Weave::Profiles::NetworkProvisioning::NetworkType networkType, uint8_t encodeFlags, uint16_t & encodedElemCount) | Serialize một mảng của NetworkInfo đối tượng vào nó TLV đại diện chỉ chọn mạng của một loại hình cụ thể. |
Các loại công khai
@ 210
@210
@ 211
@211
Thuộc tính công cộng
Ẩn
bool Hidden
Mạng có bị ẩn hay không.
NetworkId
int64_t NetworkId
Id mạng được thiết bị gán cho mạng, -1 nếu không được chỉ định.
ThreadChannel
uint8_t ThreadChannel
Kênh hiện tại (hiện tại là [11..26]) mà mạng Thread hoạt động, hoặc kThreadChannel_NotSpecified.
ThreadExtendedPANId
uint8_t * ThreadExtendedPANId
ID PAN mở rộng của Chủ đề.
Nó là một mảng được phân bổ động gồm 8 bát phân, thuộc sở hữu của lớp. Phá hủy vào bất kỳ điều kiện mà các cuộc gọi Clear()
trên đối tượng.
ThreadNetworkKey
uint8_t * ThreadNetworkKey
Khóa mạng chính của Chủ đề hoặc NULL nếu không được chỉ định.
Nó là một mảng cấp phát động của octet tùy ý, thuộc sở hữu của lớp Destroyed với điều kiện bất kỳ mà các cuộc gọi Clear()
trên đối tượng.
ThreadNetworkName
char * ThreadNetworkName
Tên của mạng Chủ đề hoặc NULL nếu không được chỉ định.
Nó là một chuỗi C được kết thúc bằng NUL, được cấp phát động, thuộc sở hữu của lớp. Phá hủy vào bất kỳ điều kiện mà các cuộc gọi Clear()
trên đối tượng.
ThreadPANId
uint32_t ThreadPANId
ID PAN luồng 16 bit hoặc kThreadPANId_NotSpecified.
ThreadPSKc
uint8_t * ThreadPSKc
Khóa chia sẻ trước chủ đề cho ủy viên hoặc NULL nếu không được chỉ định.
Nó là một mảng cấp phát động của octet tùy ý, thuộc sở hữu của lớp Destroyed với điều kiện bất kỳ mà các cuộc gọi Clear()
trên đối tượng.
WiFiKey
uint8_t * WiFiKey
Khóa WiFi hoặc NULL nếu không được chỉ định.
Nó là một mảng cấp phát động của octet tùy ý, thuộc sở hữu của các lớp, với chiều dài theo quy định của WiFiKeyLen
. Phá hủy vào bất kỳ điều kiện mà các cuộc gọi Clear()
trên đối tượng.
WiFiKeyLen
uint32_t WiFiKeyLen
Độ dài tính bằng byte của khóa WiFi.
WiFiMode
::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode
Chế độ hoạt động của mạng WiFi.
WiFiRole
::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole
Vai trò của thiết bị trên mạng WiFi.
WiFiSSID
char * WiFiSSID
SSID WiFi hoặc NULL nếu không được chỉ định.
Nó là một chuỗi C được kết thúc bằng NUL, được cấp phát động, thuộc sở hữu của lớp. Phá hủy vào bất kỳ điều kiện mà các cuộc gọi Clear()
trên đối tượng.
WiFiSecurityType
::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType
Loại bảo mật WiFi.
WirelessSignalStrength
int16_t WirelessSignalStrength
Cường độ tín hiệu của mạng hoặc INT16_MIN nếu không khả dụng / có thể áp dụng.
Chức năng công cộng
Thông thoáng
void Clear( void )
Thiết lập lại để mặc định và giải phóng tất cả các giá trị trong phạm vi này NetworkInfo đối tượng.
CopyTo
WEAVE_ERROR CopyTo( NetworkInfo & dest )
Thay thế nội dung này NetworkInfo đối tượng với các bản sao sâu sắc về nội dung của các cuộc tranh cãi.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
Giải mã
WEAVE_ERROR Decode( nl::Weave::TLV::TLVReader & reader )
Deserialize nội dung này NetworkInfo đối tượng từ nó TLV đại diện.
Chi tiết | |||
---|---|---|---|
Thông số |
| ||
Lợi nhuận | WEAVE_NO_ERROR Mở thành công, WEAVE_ERROR_INVALID_TLV_ELEMENT trên bất kỳ yếu tố không phù hợp với hồ sơ mạng provisioning, bất kỳ TLV lỗi độc giả về giải mã không chính xác của các yếu tố. |
Mã hóa
WEAVE_ERROR Encode( nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags ) const
Serialize nội dung này NetworkInfo đối tượng vào nó TLV đại diện.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Lợi nhuận | WEAVE_NO_ERROR Mở thành công, WEAVE_ERROR_INVALID_TLV_ELEMENT trên bất kỳ yếu tố không phù hợp với hồ sơ mạng provisioning, bất kỳ TLV lỗi độc giả về giải mã không chính xác của các yếu tố. |
MergeTo
WEAVE_ERROR MergeTo( NetworkInfo & dest )
Hợp nhất các nội dung này NetworkInfo đối tượng với các bản sao sâu sắc về nội dung của các cuộc tranh cãi.
Tất cả các giá trị không mặc định từ đối tượng thay thế các giá trị trong đối tượng này.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
Thông tin mạng
NetworkInfo()
~ NetworkInfo
~NetworkInfo()
Các chức năng tĩnh công khai
DecodeList
WEAVE_ERROR DecodeList( nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray )
Deserialize một danh sách các NetworkInfo yếu tố từ nó TLV đại diện.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
EncodeList
WEAVE_ERROR EncodeList( nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags )
Serialize một mảng của NetworkInfo đối tượng vào nó TLV đại diện.
Các mảng sẽ là một yếu tố vô danh trong TLV đại diện.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||
Giá trị trả lại |
|
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 )
Serialize một mảng của NetworkInfo đối tượng vào nó TLV đại diện chỉ chọn mạng của một loại hình cụ thể.
Chi tiết | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
| ||||||||||||
Giá trị trả lại |
|