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

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

實作網路佈建設定檔的伺服器類別。

摘要

繼承

沿用自： nl::Weave::WeaveServerBase
直接已知的子類別：
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt;NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt;Impl 類別 >

建構函式和解構函式
NetworkProvisioningServer(void)

受保護的屬性
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

公開屬性
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

公開函式
Init(WeaveExchangeManager *exchangeMgr)
初始化「網路佈建伺服器」狀態，並註冊以接收網路佈建訊息。
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
如果已成功新增網路，則傳送「新增網路完整」訊息。
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
傳送「Get NetworksComplete」訊息，其中包含之前掃描的網路。
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
傳送 GetWirelessRegulatoryConfigComplete 訊息給對等點。
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
傳送含有掃描結果的網路掃描完整回應訊息。
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
傳送狀態報告回應要求。
SendSuccessResponse(void)
virtual WEAVE_ERROR
傳送成功回應至網路佈建要求。
SetDelegate(NetworkProvisioningDelegate *delegate)
void
設定委派代表來處理網路佈建伺服器事件。
Shutdown(void)
關閉網路佈建伺服器。

受保護的屬性

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

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

公開屬性

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

公開函式

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

初始化「網路佈建伺服器」狀態，並註冊以接收網路佈建訊息。

詳細資料
參數
[in] exchangeMgr
指向系統 Weave Exchange Manager 的指標。
傳回值
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
已註冊的訊息處理常式過多。
WEAVE_NO_ERROR
成功時。

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

如果已成功新增網路，則傳送「新增網路完整」訊息。

詳細資料
參數
[in] networkId
所新增網路的 ID。
傳回值
WEAVE_ERROR_INCORRECT_STATE
如果網路佈建伺服器未正確初始化。
WEAVE_ERROR_NO_MEMORY
無法分配 PacketBuffer 時。
WEAVE_NO_ERROR
成功時。
other
其他 Weave 或平台專用錯誤代碼，表示因發生錯誤，裝置無法傳送「新增網路完整」訊息。

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

傳送「Get NetworksComplete」訊息，其中包含之前掃描的網路。

詳細資料
參數
[in] resultCount
掃描結果數。
[in] scanResultsTLV
掃描結果。
傳回值
WEAVE_ERROR_INCORRECT_STATE
如果網路佈建伺服器未正確初始化。
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
如果網路佈建伺服器未正確初始化。
WEAVE_ERROR_NO_MEMORY
無法分配 PacketBuffer 時。
WEAVE_NO_ERROR
成功時。
other
其他 Weave 或平台專用錯誤代碼，表示因發生錯誤，裝置無法傳送「新增網路完整」訊息。

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

傳送含有掃描結果的網路掃描完整回應訊息。

詳細資料
參數
[in] resultCount
掃描結果數。
[in] scanResultsTLV
掃描結果。
傳回值
WEAVE_ERROR_INCORRECT_STATE
如果網路佈建伺服器未正確初始化。
WEAVE_ERROR_BUFFER_TOO_SMALL
如果結果緩衝區不夠大。
WEAVE_NO_ERROR
成功時。
other
其他 Weave 或平台專屬的錯誤代碼，用於表示裝置發生錯誤，無法傳送「Scan 完整」回應。

SendStatusReport

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 或平台專屬錯誤代碼，表示因發生錯誤，裝置無法傳送狀態報告。

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

傳送成功回應至網路佈建要求。

詳細資料
傳回值
WEAVE_ERROR_INCORRECT_STATE
如果沒有處理任何要求。
WEAVE_NO_ERROR
成功時。
other
其他 Weave 或平台專屬錯誤代碼，用於表示裝置因發生錯誤而無法傳送成功回應。

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

設定委派代表來處理網路佈建伺服器事件。

詳細資料
參數
[in] delegate
網路佈建委派的指標。

關閉

WEAVE_ERROR Shutdown(
  void
)

關閉網路佈建伺服器。

詳細資料
傳回值
WEAVE_NO_ERROR
成功時。