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 để tuần tự hóa và giải mã hóa các tải trọng được truyền thông qua cấu hình NetworkProvisinstall : nó đóng gói thông tin liên quan đến 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ữ cuối cùng của thông tin và tải trọng 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 ẩ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`	`:: nl::Weave::Profiles::NetworkProvisioning::NetworkType` Loại mạng.
`ThreadChannel`	`uint8_t` Kênh hiện tại (hiện tại là [11..26]) mà mạng Chủ đề 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 của chuỗi 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`	`:: nl::Weave::Profiles::NetworkProvisioning::WiFiMode` Chế độ hoạt động của mạng WiFi.
`WiFiRole`	`:: nl::Weave::Profiles::NetworkProvisioning::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`	`:: nl::Weave::Profiles::NetworkProvisioning::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` Đặt lại về mặc định và giải phóng tất cả các giá trị trong đối tượng NetworkInfo này.
`CopyTo ( NetworkInfo & dest)`	`WEAVE_ERROR` Thay thế nội dung của đối tượng NetworkInfo này bằng bản sao sâu của nội dung của đối số.
`Decode (nl::Weave::TLV::TLVReader & reader)`	`WEAVE_ERROR` Hủy số liệu hóa nội dung của đối tượng NetworkInfo này khỏi biểu diễn TLV của nó.
`Encode (nl::Weave::TLV::TLVWriter & writer, uint8_t encodeFlags) const`	`WEAVE_ERROR` Tuần tự hóa nội dung của đối tượng NetworkInfo này thành biểu diễn TLV của nó.
`MergeTo ( NetworkInfo & dest)`	`WEAVE_ERROR` Hợp nhất nội dung của đối tượng NetworkInfo này với bản sao sâu của nội dung đối số.

Chức năng tĩnh công khai
`DecodeList (nl::Weave::TLV::TLVReader & reader, uint16_t & elemCount, NetworkInfo *& elemArray)`	`WEAVE_ERROR` Hủy số liệu hóa danh sách các phần tử NetworkInfo khỏi biểu diễn TLV của nó.
`EncodeList (nl::Weave::TLV::TLVWriter & writer, uint16_t elemCount, const NetworkInfo *elemArray, uint8_t encodeFlags)`	`WEAVE_ERROR` Nối tiếp chuỗi các đối tượng NetworkInfo thành biểu diễn TLV của 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)`	`WEAVE_ERROR` Nối tiếp một mảng các đối tượng NetworkInfo thành biểu diễn TLV của nó, chỉ chọn các mạng thuộc một loại 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 ẩ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.

Dạng kết nối

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

Loại mạng.

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. Bị hủy với bất kỳ điều kiện nào 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 cấp phát động gồm các octet tùy ý, thuộc sở hữu của lớp Bị hủy với bất kỳ điều kiện nào 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. Bị hủy với bất kỳ điều kiện nào 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 của chuỗi cho ủy viên, hoặc NULL nếu không được chỉ định.

Nó là một mảng được cấp phát động gồm các octet tùy ý, thuộc sở hữu của lớp Bị hủy với bất kỳ điều kiện nào 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 phân bổ động gồm các octet tùy ý, thuộc sở hữu của lớp, với độ dài được chỉ định bởi WiFiKeyLen . Bị phá hủy với bất kỳ điều kiện nào 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.

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
)

Đặt lại về mặc định và giải phóng tất cả các giá trị trong đối tượng NetworkInfo này.

CopyTo

WEAVE_ERROR CopyTo(
  NetworkInfo & dest
)

Thay thế nội dung của đối tượng NetworkInfo này bằng bản sao sâu của nội dung của đối số.

Chi tiết

Thông số

[in] dest

Đối tượng NetworkInfo chứa thông tin được sao chép vào đối tượng này.

Giá trị trả lại

`WEAVE_NO_ERROR`	Về thành công.
`WEAVE_ERROR_NOT_IMPLEMENTED`	Khi nền tảng không hỗ trợ malloc hoặc miễn phí.
`WEAVE_ERROR_NO_MEMORY`	Về lỗi cấp phát bộ nhớ.

Giải mã

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

Hủy số liệu hóa nội dung của đối tượng NetworkInfo này khỏi biểu diễn TLV của nó.

Chi tiết

Thông số

[in] reader

TLVReader định vị phần tử cấu trúc chứa thông tin mạng.

Lợi nhuận

WEAVE_NO_ERROR Khi thành công, WEAVE_ERROR_INVALID_TLV_ELEMENT trên bất kỳ phần tử nào không tuân theo cấu hình cung cấp mạng, bất kỳ lỗi nào trong trình đọc TLV khi giải mã sai phần tử.

Mã hóa

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

Tuần tự hóa nội dung của đối tượng NetworkInfo này thành biểu diễn TLV của nó.

Chi tiết

Thông số

`[in] writer`	TLVWriter được định vị tại nơi đối tượng sẽ được tuần tự hóa. Hàm phát thẻ ẩn danh cho đối tượng này khi đối tượng này là một phần của mảng phần tử hoặc thẻ hồ sơ cho kTag_NetworkInformation khi được phát ra dưới dạng phần tử độc lập.
`[in] encodeFlags`	Cờ kiểm soát xem thông tin đăng nhập của NetworkInfo có nên được tuần tự hóa hay không.

Lợi nhuận

WEAVE_NO_ERROR Khi thành công, WEAVE_ERROR_INVALID_TLV_ELEMENT trên bất kỳ phần tử nào không phù hợp với cấu hình cấp phép mạng, bất kỳ lỗi trình đọc TLV nào khi giải mã sai phần tử.

MergeTo

WEAVE_ERROR MergeTo(
  NetworkInfo & dest
)

Hợp nhất nội dung của đối tượng NetworkInfo này với bản sao sâu của nội dung của đối số.

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ố

[in] dest

Đối tượng NetworkInfo chứa thông tin được sao chép vào đối tượng này.

Giá trị trả lại

`WEAVE_NO_ERROR`	Về thành công.
`WEAVE_ERROR_NOT_IMPLEMENTED`	Khi nền tảng không hỗ trợ malloc hoặc miễn phí.
`WEAVE_ERROR_NO_MEMORY`	Về lỗi cấp phát bộ nhớ.

Thông tin mạng

 NetworkInfo()

~ NetworkInfo

 ~NetworkInfo()

Chức năng tĩnh công khai

DecodeList

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

Hủy số liệu hóa danh sách các phần tử NetworkInfo khỏi biểu diễn TLV của nó.

Chi tiết

Thông số

`[in] reader`	TLVReader được đặt ở vị trí bắt đầu mảng. Khi trả về thành công, người viết được định vị sau khi kết thúc mảng.
`[in,out] elemCount`	Trên đầu vào, số phần tử tối đa để giải không khí từ TLVReader. Trên đầu ra, số lượng phần tử thực sự được khử không khí khỏi luồng.
`[in,out] elemArray`	Tham chiếu đến mảng các phần tử NetworkInfo sẽ chứa các đối tượng NetworkInfo đã được giải mã . Khi mảng là NULL, nó được cấp phát bên trong bởi hàm bên dưới, nếu không, nó được giả định rằng mảng được cấp phát bên ngoài chứa ít nhất các đối tượng elemCount.

Giá trị trả lại

`WEAVE_NO_ERROR`	Về thành công.
`WEAVE_ERROR_NOT_IMPLEMENTED`	trên các nền tảng không hỗ trợ quản lý bộ nhớ động.
`other`	Lỗi trả về từ hàm `Decode()` .

EncodeList

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

Nối tiếp một mảng các đối tượng NetworkInfo thành biểu diễn TLV của nó.

Mảng sẽ là một phần tử ẩn danh trong biểu diễn TLV .

Chi tiết

Thông số

`[in] writer`	TLVWriter được định vị thích hợp
`[in] elemCount`	Số phần tử trong `elemArray` .
`[in] elemArray`	Mảng các đối tượng NetworkInfo sẽ được tuần tự hóa.
`[in] encodeFlags`	Cờ kiểm soát xem thông tin đăng nhập của NetworkInfo có nên được tuần tự hóa hay không.

Giá trị trả lại

`WEAVE_NO_ERROR`	Về thành công.
`Other`	Lỗi trả về từ hàm `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
)

Nối tiếp một mảng các đối tượng NetworkInfo thành biểu diễn TLV của nó, chỉ chọn các mạng thuộc một loại cụ thể.

Chi tiết

Thông số

`[in] writer`	TLVWriter được định vị thích hợp
`[in] arrayLen`	Số phần tử trong `elemArray` .
`[in] elemArray`	Mảng các đối tượng NetworkInfo sẽ được tuần tự hóa.
`[in] networkType`	Loại đối tượng NetworkInfo để tuần tự hóa
`[in] encodeFlags`	Cờ kiểm soát xem thông tin đăng nhập của NetworkInfo có nên được tuần tự hóa hay không.
`[out] encodedElemCount`	Số phần tử thực sự được xếp theo thứ tự

Giá trị trả lại

`WEAVE_NO_ERROR`	Về thành công.
`Other`	Lỗi trả về từ hàm `Encode()` .

nl :: Dệt :: Hồ sơ :: Quản lý mạng :: Thông tin mạng

Tóm lược

Người xây dựng và Người phá hủy

Các loại công khai

Thuộc tính công cộng

Chức năng công cộng

Chức năng tĩnh công khai

Các loại công khai

@ 210

@ 211

Thuộc tính công cộng

Ẩn

NetworkId

Dạng kết nối

ThreadChannel

ThreadExtendedPANId

ThreadNetworkKey

ThreadNetworkName

ThreadPANId

ThreadPSKc

WiFiKey

WiFiKeyLen

WiFiMode

WiFiRole

WiFiSSID

WiFiSecurityType

WirelessSignalStrength

Chức năng công cộng

Thông thoáng

CopyTo

Giải mã

Mã hóa

MergeTo

Thông tin mạng

~ NetworkInfo

Chức năng tĩnh công khai

DecodeList

EncodeList

EncodeList