nl::Weave::DeviceLayer::Internal::DeviceControlServer

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/internal/DeviceControlServer.h>

Weave デバイスの Weave デバイス コントロール プロファイルを実装します。

概要

継承

継承元:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

パブリック関数
Init()
IsPairedToAccount() const override
virtual bool
デバイスが現在アカウントとペア設定されているかどうかを確認するために呼び出されます。
IsResetAllowed(uint16_t resetFlags) override
virtual bool
指定した構成のリセットが許可されているかどうかを確認します。
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
デバイス設定のフェイルセーフが監視されたことを示します。
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
デバイス設定のフェイルセーフの監視が解除されたことを示します。
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
リモート パッシブ ランデブー プロセスが完了したことを示します。
OnRemotePassiveRendezvousStarted(void) override
virtual void
リモート パッシブ ランデブー プロセスが開始されたことを示します。
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
デバイス設定の全部または一部をリセットします。
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
指定したシステムテストを開始します。
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
進行中のシステムテストを停止します。
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
サーバー接続が存在する場合は、構成をリセットする前に閉じる必要があるかどうかを決定します。
WillCloseRemotePassiveRendezvous(void) override
virtual void
リモートパッシブランデブの停止準備をします。
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
リモートからのパッシブ ランデブーの準備をします。

プロテクト関数
DeviceControlServer()=default
DeviceControlServer(const DeviceControlServer &)=delete
DeviceControlServer(const DeviceControlServer &&)=delete
operator=(const DeviceControlServer &)=delete
~DeviceControlServer()=default

パブリック関数

init

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

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

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

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

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

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

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

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

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

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

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

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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

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

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

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

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

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

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

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

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

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

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

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

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

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

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

関連情報:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

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

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

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

プロテクト関数

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default