nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningDelegate

Đây là lớp trừu tượng.

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

Lớp uỷ quyền triển khai các hoạt động Cấp phép mạng.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::WeaveServerDelegateBase


Thuộc tính công khai

Server
[READ ONLY] Đối tượng máy chủ mà đại diện này được đính kèm.

Hàm công khai

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Thực thi kiểm soát quyền truy cập ở cấp thông báo đối với thông báo gửi đến cho yêu cầu Cấp phép mạng.
HandleAddNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Thêm một mạng cụ thể.
HandleDisableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Tắt mạng được chỉ định.
HandleEnableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Bật mạng được chỉ định.
HandleGetNetworks(uint8_t flags)=0
virtual WEAVE_ERROR
Tải các mạng đã định cấu hình.
HandleGetWirelessRegulatoryConfig(void)
virtual WEAVE_ERROR
Nhận thông tin về cấu hình theo quy định của mạng không dây.
HandleRemoveNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Xoá mạng đã định cấu hình.
HandleScanNetworks(uint8_t networkType)=0
virtual WEAVE_ERROR
Quét mạng.
HandleSetRendezvousMode(uint16_t rendezvousMode)=0
virtual WEAVE_ERROR
Đặt chế độ điểm hẹn.
HandleSetWirelessRegulatoryConfig(PacketBuffer *regConfigTLV)
virtual WEAVE_ERROR
Thiết lập thông tin về cấu hình theo quy định của mạng không dây.
HandleTestConnectivity(uint32_t networkId)=0
virtual WEAVE_ERROR
Kiểm tra kết nối của mạng đã chỉ định.
HandleUpdateNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Cập nhật cấu hình của mạng.
IsPairedToAccount() const
virtual bool
Được gọi để xác định xem thiết bị hiện đã được ghép nối với một tài khoản hay chưa.

Thuộc tính công khai

Máy chủ

NetworkProvisioningServer * Server

[READ ONLY] Đối tượng máy chủ mà đại diện này được đính kèm.

Hàm công khai

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Thực thi kiểm soát quyền truy cập ở cấp thông báo đối với thông báo gửi đến cho yêu cầu Cấp phép mạng.

Thông tin chi tiết
Thông số
[in] ec
ExchangeContext thông báo nhận được.
[in] msgProfileId
Mã hồ sơ của thư đã nhận.
[in] msgType
Loại thông báo của thông báo đã nhận.
[in] msgInfo
Cấu trúc WeaveMessageInfo chứa thông tin về tin nhắn đã nhận.
[in,out] result
Một giá trị liệt kê mô tả kết quả đánh giá chính sách kiểm soát quyền truy cập cho thông báo nhận được. Khi vào phương thức, giá trị này đại diện cho kết quả dự kiến tại điểm hiện tại trong quá trình đánh giá. Khi gửi lại, kết quả dự kiến sẽ thể hiện đánh giá cuối cùng về chính sách kiểm soát quyền truy cập đối với thông báo.

HandleAddNetwork

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

Thêm một mạng cụ thể.

Thông tin chi tiết
Thông số
[in] networkInfoTLV
Cấu hình mạng được mã hoá bằng TLV.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi khác của Weave hoặc nền tảng cụ thể cho biết đã xảy ra lỗi khiến thiết bị không thêm được mạng.
Vui lòng xem thêm:
NetworkProvisioningDataElementTags để biết các loại hợp lệ.

HandleDisableNetwork

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

Tắt mạng được chỉ định.

Thông tin chi tiết
Thông số
[in] networkId
Mã của mạng cần tắt.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi ngăn thiết bị tắt mạng.

HandleEnableNetwork

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

Bật mạng được chỉ định.

Thông tin chi tiết
Thông số
[in] networkId
Mã của mạng cần bật.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi khiến thiết bị không bật được mạng.

HandleGetNetworks

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

Tải các mạng đã định cấu hình.

Thông tin chi tiết
Thông số
[in] flags
Gắn cờ để lọc các mạng đã truy xuất.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi khiến thiết bị không nhận được các mạng đã định cấu hình.

HandleGetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

Nhận thông tin về cấu hình theo quy định của mạng không dây.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi khiến thiết bị không tìm nạp được thông tin được yêu cầu.

HandleRemoveNetwork

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

Xoá mạng đã định cấu hình.

Thông tin chi tiết
Thông số
[in] networkId
Mã của mạng cần xoá.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi khác của Weave hoặc nền tảng cụ thể cho biết đã xảy ra lỗi khiến thiết bị không xoá được mạng.

HandleScanNetworks

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

Quét mạng.

Thông tin chi tiết
Thông số
[in] networkType
Công nghệ (ví dụ: Wi-Fi hoặc Thread) để quét.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi khác của Weave hoặc nền tảng cụ thể cho biết đã xảy ra lỗi khiến thiết bị không thực hiện quét mạng được.
Xem thêm:
NetworkType để biết các loại hợp lệ.

HandleSetRendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

Đặt chế độ điểm hẹn.

Thông tin chi tiết
Thông số
[in] rendezvousMode
Chế độ điểm hẹn mà bạn nên sử dụng.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi khiến thiết bị không đặt được chế độ điểm hẹn.
Xem thêm:
RendezvousModeFlags để biết các chế độ hợp lệ.

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

Thiết lập thông tin về cấu hình theo quy định của mạng không dây.

Thông tin chi tiết
Thông số
[in] regConfigTLV
Vùng đệm gói chứa thông tin cấu hình quy định không dây mới được mã hoá theo định dạng TLV.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi khiến thiết bị không thể đặt thông tin được yêu cầu.

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

Kiểm tra kết nối của mạng đã chỉ định.

Thông tin chi tiết
Thông số
[in] networkId
Mã của mạng để kiểm tra khả năng kết nối.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi riêng của Weave hoặc nền tảng khác cho biết đã xảy ra lỗi khiến thiết bị không kiểm tra được khả năng kết nối.

HandleUpdateNetwork

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

Cập nhật cấu hình của mạng.

Thông tin chi tiết
Thông số
[in] networkInfoTLV
Cấu hình mạng được mã hoá bằng TLV.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
other
Các mã lỗi khác của Weave hoặc nền tảng cụ thể cho biết đã xảy ra lỗi ngăn thiết bị cập nhật mạng.
Vui lòng xem thêm:
NetworkProvisioningDataElementTags để biết các loại hợp lệ.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

Được gọi để xác định xem thiết bị hiện đã được ghép nối với một tài khoản hay chưa.