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

Đây là một 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
Lớp học con đã biết trực tiếp:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; Network cấpingServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

Các thuộc tính công khai

Server
[CHỈ ĐỌC] Đối tượng máy chủ mà ủy quyề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ư cho thông báo yêu cầu Cấp phép mạng đến.
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 đã chỉ định.
HandleEnableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Bật mạng đã chỉ định.
HandleGetNetworks(uint8_t flags)=0
virtual WEAVE_ERROR
Lấy 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ột 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
Đặt thông tin 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 khả năng 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ó được ghép nối với một tài khoản nào đó hay không.

Các thuộc tính công khai

Máy chủ

NetworkProvisioningServer * Server

[CHỈ ĐỌC] Đối tượng máy chủ mà ủy quyề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ư cho thông báo yêu cầu Cấp phép mạng đến.

Thông tin chi tiết
Tham số
[in] ec
ExchangeContext mà thông qua đó đã được nhận.
[in] msgProfileId
Mã hồ sơ của thư đã nhận.
[in] msgType
Loại tin nhắn của tin nhắn đã 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ị được liệt kê mô tả kết quả đánh giá chính sách kiểm soát quyền truy cập đối với thông báo đã nhận. Khi bắt đầu vào phương thức này, giá trị này biểu thị kết quả dự kiến ở thời điểm hiện tại trong quá trình đánh giá. Khi trả lại thông báo, kết quả dự kiến sẽ là kết quả đá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
Tham số
[in] networkInfoTLV
Cấu hình mạng được mã hoá theo 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 dành riêng cho nền tảng cho biết đã xảy ra lỗi ngăn thiết bị thêm mạ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 đã chỉ định.

Thông tin chi tiết
Tham 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 khác của Weave hoặc dành riêng cho nền tảng 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 đã chỉ định.

Thông tin chi tiết
Tham 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 khác của Weave hoặc dành riêng cho nền tảng 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

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

Thông tin chi tiết
Tham số
[in] flags
Gắn cờ để lọc các mạng được truy xuấ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 dành riêng cho nền tảng 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 khác của Weave hoặc dành riêng cho nền tảng cho biết đã xảy ra lỗi ngăn thiết bị tìm nạp thông tin được yêu cầu.

HandleRemoveNetwork

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

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

Thông tin chi tiết
Tham 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 dành riêng cho nền tảng 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
Tham 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 dành riêng cho nền tảng cho biết đã xảy ra lỗi khiến thiết bị không thực hiện được quá trình quét mạng.
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
Tham số
[in] rendezvousMode
Chế độ điểm hẹn để sử dụng.
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 dành riêng cho nền tảng cho biết đã xảy ra lỗi ngăn thiết bị đặt chế độ điểm hẹn.
Xem thêm:
RendezvousModeFlags để biết các chế độ hợp lệ.

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

Đặt thông tin cấu hình theo quy định của mạng không dây.

Thông tin chi tiết
Tham số
[in] regConfigTLV
Vùng đệm gói chứa thông tin cấu hình mới theo quy định của mạng không dây đượ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 khác của Weave hoặc dành riêng cho nền tảng cho biết đã xảy ra lỗi ngăn thiết bị đặt thông tin được yêu cầu.

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

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

Thông tin chi tiết
Tham số
[in] networkId
Mã nhận dạng của mạng cần 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 khác của Weave hoặc dành riêng cho nền tảng cho biết đã xảy ra lỗi ngăn thiết bị kiểm tra 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
Tham số
[in] networkInfoTLV
Cấu hình mạng được mã hoá theo 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 dành riêng cho nền tảng cho biết đã xảy ra lỗi khiến thiết bị không cập nhật được mạ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ó được ghép nối với một tài khoản nào đó hay không.