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;ImplClass >

パブリック属性
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

デバイスが現在アカウントとペア設定されているかどうかを確認するために呼び出されます。