nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

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

Lớp máy chủ để triển khai hồ sơ Cấp phép mạng.

Tóm tắt

Tính kế thừa

Kế thừa từ: nl::Weave::WeaveServerBase
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 >

Hàm khởi tạo và phá huỷ
NetworkProvisioningServer(void)

Thuộc tính được bảo vệ
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Các thuộc tính công khai
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Hàm công khai
Init(WeaveExchangeManager *exchangeMgr)
Khởi động trạng thái Máy chủ cấp phép mạng và đăng ký để nhận thông báo Cấp phép mạng.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Gửi thông báo Thêm mạng đã hoàn tất nếu đã thêm mạng thành công.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Gửi thông báo Lấy thông tin mạng hoàn chỉnh chứa các mạng đã quét trước đó.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Gửi thông báo GetWirelessMeasureCompleteConfigComplete đến ứng dụng ngang hàng.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Gửi thư phản hồi Hoàn tất việc quét mạng có chứa kết quả quét.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Gửi phản hồi báo cáo trạng thái cho một yêu cầu.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Gửi phản hồi thành công cho yêu cầu Cấp phép mạng.
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Đặt phương thức uỷ quyền để xử lý sự kiện Máy chủ cấp phép mạng.
Shutdown(void)
Tắt máy chủ cấp phép mạng.

Thuộc tính được bảo vệ

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult

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

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Hàm công khai

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Khởi động trạng thái Máy chủ cấp phép mạng và đăng ký để nhận thông báo Cấp phép mạng.

Thông tin chi tiết
Tham số
[in] exchangeMgr
Con trỏ trỏ đến hệ thống Weave Exchange Manager.
Giá trị trả về
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Trường hợp có quá nhiều trình xử lý thư đã được đăng ký.
WEAVE_NO_ERROR
Khi thành công.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Gửi thông báo Thêm mạng đã hoàn tất nếu đã thêm mạng thành công.

Thông tin chi tiết
Tham số
[in] networkId
Mã của mạng được thêm.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu Máy chủ cấp phép mạng không được khởi chạy đúng cách.
WEAVE_ERROR_NO_MEMORY
Khi không phân bổ được PacketBuffer.
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ị gửi thông báo Thêm mạng hoàn chỉnh.

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Gửi thông báo Lấy thông tin mạng hoàn chỉnh chứa các mạng đã quét trước đó.

Thông tin chi tiết
Tham số
[in] resultCount
Số kết quả quét.
[in] scanResultsTLV
Kết quả quét.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu Máy chủ cấp phép mạng không được khởi chạy đúng cách.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu vùng đệm kết quả không đủ lớn.
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ị gửi thông báo Nhận mạng hoàn tất.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Gửi thông báo GetWirelessĐiều hướngConfigComplete đến ứng dụng ngang hàng.

Thông tin chi tiết
Tham số
[in] resultsTLV
Vùng đệm gói chứa thông tin cấu hình theo quy định của mạng không dây cần trả về.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu Máy chủ cấp phép mạng không được khởi chạy đúng cách.
WEAVE_ERROR_NO_MEMORY
Khi không phân bổ được PacketBuffer.
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ị gửi thông báo Thêm mạng hoàn chỉnh.

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Gửi thư phản hồi Hoàn tất việc quét mạng có chứa kết quả quét.

Thông tin chi tiết
Tham số
[in] resultCount
Số kết quả quét.
[in] scanResultsTLV
Kết quả quét.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu Máy chủ cấp phép mạng không được khởi chạy đúng cách.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu vùng đệm kết quả không đủ lớn.
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 gửi được phản hồi Quét hoàn tất.

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Gửi phản hồi báo cáo trạng thái cho một yêu cầu.

Thông tin chi tiết
Tham số
[in] statusProfileId
Mã hồ sơ Weave có liên quan đến báo cáo trạng thái này.
[in] statusCode
Mã trạng thái được đưa vào phản hồi này.
[in] sysError
Mã lỗi hệ thống được đưa vào phản hồi này.
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu không có yêu cầu nào đang được xử lý.
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 gửi được báo cáo trạng thái.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Gửi phản hồi thành công cho yêu cầu Cấp phép mạng.

Thông tin chi tiết
Giá trị trả về
WEAVE_ERROR_INCORRECT_STATE
Nếu không có yêu cầu nào đang được xử lý.
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ị gửi phản hồi thành công.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Đặt phương thức uỷ quyền để xử lý sự kiện Máy chủ cấp phép mạng.

Thông tin chi tiết
Tham số
[in] delegate
Con trỏ tới Người được uỷ quyền cấp phép mạng.

Tắt

WEAVE_ERROR Shutdown(
  void
)

Tắt máy chủ cấp phép mạng.

Thông tin chi tiết
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.