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

這是抽象類別。

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

實作網路佈建作業的委派類別。

摘要

繼承

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

公開屬性
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

[唯讀] 附加此委派代表的伺服器物件。

公開函式

EnforceAccessControl

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

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

詳細資料
參數
[in] ec
接收訊息的 ExchangeContext。
[in] msgProfileId
接收訊息的個人資料 ID。
[in] msgType
接收訊息的訊息類型。
[in] msgInfo
包含已接收訊息相關資訊的 WeaveMessageInfo 結構。
[in,out] result
一個列舉值，說明接收訊息的存取權控管政策評估結果。輸入方法後，值代表評估程序中目前時間點的暫定結果。傳回後，結果應代表該訊息的最終存取權控管政策評估。

HandleAddNetwork

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

新增特定網路。

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

HandleDisableNetwork

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

停用指定網路。

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

HandleEnableNetwork

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

啟用指定網路。

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

HandleGetNetworks

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

取得設定好的網路。

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

HandleGetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

取得無線法規設定資訊。

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

HandleRemoveNetwork

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

移除已設定的網路。

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

HandleScanNetworks

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

執行網路掃描。

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

HandleSetRendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

設定算繪模式。

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

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

設定無線法規設定資訊。

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

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

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

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

HandleUpdateNetwork

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

更新網路設定。

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

IsPairedToAccount

virtual bool IsPairedToAccount() const

呼叫此方法會判斷裝置目前是否已經與帳戶配對。