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

此為抽象類別。

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

用於實作網路帳戶管理作業的委派類別。

總結

繼承

繼承來源： nl::Weave::WeaveServerDelegateBase
Direct 已知子類別：
nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
nl::Weap&mpl;IptII

公開屬性
Server
[唯讀] 此委派目標附屬的伺服器物件。

公開函式
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
針對收到的網路佈建要求訊息強制執行訊息層級存取權控管機制。
HandleAddNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
新增特定網路。
HandleDisableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
停用指定的網路。
HandleEnableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
啟用指定的網路。
HandleGetNetworks(uint8_t flags)=0
virtual WEAVE_ERROR
取得已設定的網路。
HandleGetWirelessRegulatoryConfig(void)
virtual WEAVE_ERROR
取得無線法規設定資訊。
HandleRemoveNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
移除已設定的網路。
HandleScanNetworks(uint8_t networkType)=0
virtual WEAVE_ERROR
執行網路掃描。
HandleSetRendezvousMode(uint16_t rendezvousMode)=0
virtual WEAVE_ERROR
設定預設模式。
HandleSetWirelessRegulatoryConfig(PacketBuffer *regConfigTLV)
virtual WEAVE_ERROR
調整無線法規設定資訊。
HandleTestConnectivity(uint32_t networkId)=0
virtual WEAVE_ERROR
測試指定網路的連線能力。
HandleUpdateNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
更新網路設定。
IsPairedToAccount() const
virtual bool
系統會呼叫，判斷裝置目前是否與某個帳戶配對。

公開屬性

伺服器

NetworkProvisioningServer * Server

[唯讀] 此委派目標附屬的伺服器物件。

公開函式

強制執行存取控制

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

針對收到的網路佈建要求訊息強制執行訊息層級存取權控管機制。

詳細資料
參數
[in] ec
接收郵件的 ExchangeContext。
[in] msgProfileId
所接收訊息的設定檔編號。
[in] msgType
所接收郵件的訊息類型。
[in] msgInfo
WeaveMessageInfo 結構，其中包含所接收郵件的相關資訊。
[in,out] result
列舉值，說明所接收訊息的存取權控制政策評估結果。進入方法時，這個值代表評估過程中目前時間點的暫定結果。傳回結果後，結果應該會是郵件最終存取權政策的最終評估結果。

處理網路

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

新增特定網路。

詳細資料
參數
[in] networkInfoTLV
以 TLV 編碼的網路設定。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法新增網路。
另請參閱：
NetworkProvisioningDataElementTags 以瞭解有效類型。

處理網路停用

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

停用指定的網路。

詳細資料
參數
[in] networkId
要停用的網路 ID。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法停用網路。

處理啟用網路

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

啟用指定的網路。

詳細資料
參數
[in] networkId
要啟用的網路 ID。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法啟用網路。

取得 GetNetwork

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

取得已設定的網路。

詳細資料
參數
[in] flags
用來篩選已擷取網路的旗標。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法取得已設定的網路。

取得 GetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

取得無線法規設定資訊。

詳細資料
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，指出發生錯誤導致裝置無法擷取要求的資訊。

處理移除網路

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

移除已設定的網路。

詳細資料
參數
[in] networkId
要移除的聯播網 ID。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法移除網路。

景點掃描網路

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

執行網路掃描。

詳細資料
參數
[in] networkType
要掃描的技術 (例如 WiFi 或 Thread)。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法執行網路掃描。
另請參閱：
NetworkType 以瞭解有效類型。

處理常式設定 RendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

設定預設模式。

詳細資料
參數
[in] rendezvousMode
要使用的預設模式。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法設定預設模式。
另請參閱：
RendezvousModeFlags 以取得有效模式。

處理常式設定 WirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

調整無線法規設定資訊。

詳細資料
參數
[in] regConfigTLV
這個封包緩衝區包含採用 TLV 格式編碼的新無線法規設定資訊。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，指出發生錯誤導致裝置無法設定所要求的資訊。

處理測試連線

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

測試指定網路的連線能力。

詳細資料
參數
[in] networkId
測試連線的網路 ID。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，代表發生錯誤，導致裝置無法測試連線能力。

處理更新網路

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

更新網路設定。

詳細資料
參數
[in] networkInfoTLV
以 TLV 編碼的網路設定。
傳回值
WEAVE_NO_ERROR
成功。
other
其他 Weave 或平台專屬的錯誤代碼，表示發生錯誤導致裝置無法更新網路。
另請參閱：
NetworkProvisioningDataElementTags 以瞭解有效類型。

是否為配對帳戶

virtual bool IsPairedToAccount() const

系統會呼叫，判斷裝置目前是否與某個帳戶配對。