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

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

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

詳細
パラメータ
[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
リモート パッシブ Rendezvous の開始の準備中にエラーが発生したことを示すその他の Weave またはプラットフォーム固有のエラーコード。