本頁面由 Cloud Translation API 翻譯而成。

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

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

實作 Weave 裝置的 Weave Device Control 設定檔。

摘要

繼承

沿用自：
nl::Weave::Profiles::DeviceControl::DeviceControlServer
nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

公用函式
`Init()`	`WEAVE_ERROR`
`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` 表示遠端被動 Rendezvous 程序已完成。
`OnRemotePassiveRendezvousStarted(void) override`	`virtual void` 表示遠端被動 Rendezvous 程序已開始。
`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` 準備停止遠端被動 Rendezvous。
`WillStartRemotePassiveRendezvous(void) override`	`virtual WEAVE_ERROR` 準備遠端被動風車。

受保護的函式
`DeviceControlServer()=default`
`DeviceControlServer(const DeviceControlServer &)=delete`
`DeviceControlServer(const DeviceControlServer &&)=delete`
`operator=(const DeviceControlServer &)=delete`	`DeviceControlServer &`
`~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

表示遠端被動 Rendezvous 程序已完成。

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

表示遠端被動 Rendezvous 程序已開始。

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

在重設設定前，決定是否應關閉伺服器連線 (如果有的話)。

處理設定重設要求時，這個函式可用來查詢委派代表想要的行為。如果伺服器連線目前處於有效狀態，在透過 OnResetConfig 方法觸發設定重設前，這個方法的 TRUE 回應就會關閉該連線。

詳細說明

參數

[in] resetFlags

指定要重設哪些設定的旗標。

傳回值

`true`	即可啟用連線。
`false`	表示連線不需要關閉。

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

準備停止遠端被動 Rendezvous。

另請參閱：
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

準備遠端被動風車。

舉例來說，你可以將 15.4/Thread 網路設為可連接的網路。

詳細說明

傳回值

`WEAVE_NO_ERROR`	成功時。
`other`	其他 Weave 或平台專屬錯誤代碼，用於指出準備啟動遠端被動 Rendezvous 時發生錯誤。

受保護的函式

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

運算子=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default