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

プロテクト関数

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

演算子=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default