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 リクエスト メッセージにメッセージ レベルのアクセス制御を適用します。
詳細 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
IsPairedToAccount
virtual bool IsPairedToAccount() const
デバイスが現在アカウントとペア設定されているかどうかを判断するために呼び出されます。
IsResetAllowed
virtual bool IsResetAllowed( uint16_t resetFlags )=0
指定した構成のリセットが許可されているかどうかを確認します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
OnConnectionMonitorTimeout
virtual void OnConnectionMonitorTimeout( uint64_t peerNodeId, IPAddress peerAddr )=0
接続モニターのタイムアウトが発生したことを示します。
この関数は、接続モニターのタイムアウトが発生したとき、つまり一定の期間、リモートホストからの実行チェックが検出されなかったときに呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
OnFailSafeArmed
virtual WEAVE_ERROR OnFailSafeArmed( void )=0
デバイス設定のフェイルセーフが監視中であることを示します。
この関数は、クライアントからのリクエストに応じてサーバー デバイス設定のフェイルセーフが監視されたときに呼び出されます。設定プロセスが正常に完了しなかった場合、フェイルセーフはデバイス設定を自動的に既知の状態にリセットします。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
OnFailSafeDisarmed
virtual WEAVE_ERROR OnFailSafeDisarmed( void )=0
デバイス設定のフェイルセーフによる監視が解除されたことを示します。
この関数は、クライアントからのリクエストに応答してサーバー デバイス設定のフェイルセーフが解除されたときに呼び出されます。構成が完了すると、クライアントはフェイルセーフによる監視を解除します。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
OnRemotePassiveRendezvousDone
virtual void OnRemotePassiveRendezvousDone( void )=0
リモート パッシブ ランデブス プロセスが完了したことを示します。
OnRemotePassiveRendezvousStarted
virtual void OnRemotePassiveRendezvousStarted( void )=0
リモート パッシブ ランデブス プロセスが開始されたことを示します。
OnResetConfig
virtual WEAVE_ERROR OnResetConfig( uint16_t resetFlags )=0
デバイス設定のすべてまたは一部をリセットします。
この関数の実装では、リセットフラグに従って、ネットワーク、Weave ファブリック、またはサービス構成の任意の組み合わせを既知の状態にリセットすることが想定されています。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
OnSystemTestStarted
virtual WEAVE_ERROR OnSystemTestStarted( uint32_t profileId, uint32_t testId )=0
指定したシステムテストを開始します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
OnSystemTestStopped
virtual WEAVE_ERROR OnSystemTestStopped( void )=0
進行中のシステムテストを停止します。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|
ShouldCloseConBeforeResetConfig
virtual bool ShouldCloseConBeforeResetConfig( uint16_t resetFlags )=0
サーバー接続がある場合は、構成をリセットする前に閉じるかどうかを決定します。
この関数は、設定のリセットリクエストを処理する際にデリゲートに対して望ましい動作を照会するために使用されます。サーバー接続が現在アクティブな場合、このメソッドに対する TRUE レスポンスにより、OnResetConfig メソッドによって構成のリセットがトリガーされる前に、その接続が閉じられます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
WillCloseRemotePassiveRendezvous
virtual void WillCloseRemotePassiveRendezvous( void )=0
WillStartRemotePassiveRendezvous
virtual WEAVE_ERROR WillStartRemotePassiveRendezvous( void )=0
リモート パッシブ ランデブの準備をしましょう。
たとえば、15.4/Thread ネットワークに参加できるようにします。
詳細 | |||||
---|---|---|---|---|---|
戻り値 |
|