NL::編織::簡介::網絡供應::網絡供應服務器
#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>
用於實現網絡供應配置文件的服務器類。
概括
遺產
:從繼承NL ::編織:: WeaveServerBase直接已知的子類: nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl<NetworkProvisioningServerImpl> nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl<ImplClass> 受保護的屬性
mCurOpType
uint8_t mCurOpType
運行結果
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult
公共屬性
狀態配置文件 ID
uint32_t StatusProfileId
公共職能
在裡面
WEAVE_ERROR Init(
WeaveExchangeManager *exchangeMgr
)
初始化網絡供應服務器狀態並註冊以接收網絡供應消息。
細節 | 參數 | [in] exchangeMgr | 指向系統 Weave Exchange Manager 的指針。 |
|
返回值 | WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS | 如果已經註冊了太多的消息處理程序。 | WEAVE_NO_ERROR | 關於成功。 |
|
網絡供應服務器
NetworkProvisioningServer(
void
)
發送添加網絡完成
virtual WEAVE_ERROR SendAddNetworkComplete(
uint32_t networkId
)
如果網絡已成功添加,則發送添加網絡完成消息。
細節 | 參數 | |
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果 Network Provisioning Server 未正確初始化。 | WEAVE_ERROR_NO_MEMORY | 分配 PacketBuffer 失敗時。 | WEAVE_NO_ERROR | 關於成功。 | other | 其他 Weave 或特定於平台的錯誤代碼表示發生錯誤,阻止設備發送添加網絡完成消息。 |
|
發送獲取網絡完成
virtual WEAVE_ERROR SendGetNetworksComplete(
uint8_t resultCount,
PacketBuffer *resultsTLV
)
發送包含先前掃描的網絡的獲取網絡完成消息。
細節 | 參數 | [in] resultCount | 掃描結果的數量。 | [in] scanResultsTLV | 掃描結果。 |
|
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果 Network Provisioning Server 未正確初始化。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果結果緩衝區不夠大。 | WEAVE_NO_ERROR | 關於成功。 | other | 其他 Weave 或特定於平台的錯誤代碼表示發生錯誤,阻止設備發送 Get Networks Complete 消息。 |
|
SendGetWirelessRegulatoryConfigComplete
virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
PacketBuffer *resultsTLV
)
向對等方發送 GetWirelessRegulatoryConfigComplete 消息。
細節 | 參數 | [in] resultsTLV | 包含要返回的無線監管配置信息的數據包緩衝區。 |
|
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果 Network Provisioning Server 未正確初始化。 | WEAVE_ERROR_NO_MEMORY | 分配 PacketBuffer 失敗時。 | WEAVE_NO_ERROR | 關於成功。 | other | 其他 Weave 或特定於平台的錯誤代碼表示發生錯誤,阻止設備發送添加網絡完成消息。 |
|
發送網絡掃描完成
virtual WEAVE_ERROR SendNetworkScanComplete(
uint8_t resultCount,
PacketBuffer *scanResultsTLV
)
發送包含掃描結果的網絡掃描完成響應消息。
細節 | 參數 | [in] resultCount | 掃描結果的數量。 | [in] scanResultsTLV | 掃描結果。 |
|
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果 Network Provisioning Server 未正確初始化。 | WEAVE_ERROR_BUFFER_TOO_SMALL | 如果結果緩衝區不夠大。 | WEAVE_NO_ERROR | 關於成功。 | other | 其他 Weave 或特定於平台的錯誤代碼表示發生錯誤,阻止設備發送掃描完成響應。 |
|
發送狀態報告
virtual WEAVE_ERROR SendStatusReport(
uint32_t statusProfileId,
uint16_t statusCode,
WEAVE_ERROR sysError
)
發送對請求的狀態報告響應。
細節 | 參數 | [in] statusProfileId | 此狀態報告涉及的 Weave 配置文件 ID。 | [in] statusCode | 要包含在此響應中的狀態代碼。 | [in] sysError | 要包含在此響應中的系統錯誤代碼。 |
|
返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果沒有正在處理的請求。 | WEAVE_NO_ERROR | 關於成功。 | other | 其他 Weave 或特定於平台的錯誤代碼,表明發生了阻止設備發送狀態報告的錯誤。 |
|
發送成功響應
virtual WEAVE_ERROR SendSuccessResponse(
void
)
向網絡供應請求發送成功響應。
細節 | 返回值 | WEAVE_ERROR_INCORRECT_STATE | 如果沒有正在處理的請求。 | WEAVE_NO_ERROR | 關於成功。 | other | 其他 Weave 或特定於平台的錯誤代碼表示發生錯誤,阻止設備發送成功響應。 |
|