nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

これは抽象クラスです。

#include <src/lib/profiles/device-control/DeviceControl.h>

サーバー デバイス上の受信デバイス コントロール操作を実装するためのデリゲート クラス。

概要

継承

継承元: nl::Weave::WeaveServerDelegateBase
直系の既知のサブクラス: nl::Weave::DeviceLayer::Internal::DeviceControlServer

パブリック関数
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
受信した DeviceControl リクエスト メッセージにメッセージ レベルのアクセス制御を適用します。
IsPairedToAccount() const
virtual bool
デバイスが現在アカウントとペア設定されているかどうかを確認するために呼び出されます。
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
指定した構成のリセットが許可されているかどうかを確認します。
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
接続モニターのタイムアウトが発生したことを示します。
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
デバイス設定のフェイルセーフが監視されたことを示します。
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
デバイス設定のフェイルセーフの監視が解除されたことを示します。
OnRemotePassiveRendezvousDone(void)=0
virtual void
リモート パッシブ ランデブー プロセスが完了したことを示します。
OnRemotePassiveRendezvousStarted(void)=0
virtual void
リモート パッシブ ランデブー プロセスが開始されたことを示します。
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
デバイス設定の全部または一部をリセットします。
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
指定したシステムテストを開始します。
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
進行中のシステムテストを停止します。
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
サーバー接続が存在する場合は、構成をリセットする前に閉じる必要があるかどうかを決定します。
WillCloseRemotePassiveRendezvous(void)=0
virtual void
リモート・パッシブ・ランデブの停止準備をします。
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
リモートからのパッシブ ランデブーの準備をします。

パブリック関数

EnforceAccessControl

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

受信した DeviceControl リクエスト メッセージにメッセージ レベルのアクセス制御を適用します。

詳細
パラメータ
[in] ec
メッセージを受信した ExchangeContext。
[in] msgProfileId
受信したメッセージのプロファイル ID。
[in] msgType
受信したメッセージのメッセージ タイプ。
[in] msgInfo
受信したメッセージに関する情報を含む WeaveMessageInfo 構造体。
[in,out] result
受信したメッセージのアクセス制御ポリシーの評価結果を表す列挙値。メソッドに入ると、この値は評価プロセスの現在の時点での暫定的な結果を表します。返される結果には、メッセージのアクセス制御ポリシーの最終評価を表すことが求められます。

IsPairedToAccount

virtual bool IsPairedToAccount() const

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

指定した構成のリセットが許可されているかどうかを確認します。

詳細
パラメータ
[in] resetFlags
リセットする構成を指定するフラグ。
戻り値
TRUE
許可するかどうかを選択できます。
FALSE
許可または拒否されます。

OnConnectionMonitorTimeout

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

接続モニターのタイムアウトが発生したことを示します。

この関数は、Connection Monitor のタイムアウトが発生したとき、つまり、リモート ホストから一定の時間実行チェックが検出されないときに呼び出されます。

詳細
パラメータ
[in] peerNodeId
接続のライブネスがタイムアウトしたリモートピアのノード ID。
[in] peerAddr
リモートピアのアドレス。

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

デバイス設定のフェイルセーフが監視されたことを示します。

この関数は、クライアントからのリクエストに応答してサーバー デバイスの構成でフェイルセーフが作動した場合に呼び出されます。フェイルセーフ機能は、構成プロセスが正常に完了しなかった場合に、デバイス構成を既知の状態に自動的にリセットします。

詳細
戻り値
WEAVE_NO_ERROR
成功時。
other
フェイルセーフの監視を妨げるエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

デバイス設定のフェイルセーフの監視が解除されたことを示します。

この関数は、クライアントからのリクエストに応じてサーバー デバイスの構成でフェイルセーフの監視が解除された場合に呼び出されます。構成が完了すると、クライアントはフェイルセーフの監視を解除します。

詳細
戻り値
WEAVE_NO_ERROR
成功時。
other
フェイルセーフによる監視の解除を妨げるエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

リモート パッシブ ランデブー プロセスが完了したことを示します。

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

リモート パッシブ ランデブー プロセスが開始されたことを示します。

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

デバイス設定の全部または一部をリセットします。

この関数の実装では、リセットフラグに従って、ネットワーク、Weave ファブリック、サービス構成の組み合わせを既知の状態にリセットすることが期待されます。

詳細
パラメータ
[in] resetFlags
リセットする構成を指定するフラグ。
戻り値
WEAVE_NO_ERROR
成功時。
other
デバイスで設定をリセットできないエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

指定したシステムテストを開始します。

詳細
パラメータ
[in] profileId
リクエストされたテストのプロファイルの ID。
[in] testId
リクエストされたテストの ID。
戻り値
WEAVE_NO_ERROR
成功時。
other
システムテストを開始できなかったことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

進行中のシステムテストを停止します。

詳細
戻り値
WEAVE_NO_ERROR
成功時。
other
システムテストを停止できないエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

サーバー接続が存在する場合は、構成をリセットする前に閉じる必要があるかどうかを決定します。

この関数は、構成リセット リクエストを処理する際にデリゲートに対してクエリを実行し、必要な動作を確認するために使用されます。サーバー接続が現在アクティブな場合、このメソッドに TRUE レスポンスを返すと、OnResetConfig メソッドによって設定のリセットがトリガーされる前に、その接続が閉じられます。

詳細
パラメータ
[in] resetFlags
リセットする構成を指定するフラグ。
戻り値
true
閉じる必要があります。
false
閉じる必要があります。

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

リモートパッシブランデブの停止準備をします。

関連情報:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

リモートからのパッシブ ランデブーの準備をします。

たとえば、15.4/Thread ネットワークを参加可能にします。

詳細
戻り値
WEAVE_NO_ERROR
成功時。
other
リモート パッシブ ランデブーの開始準備中にエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。