NL::编织::设备层::内部的::设备控制服务器

#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

公共职能

在里面

WEAVE_ERROR Init()

与帐户配对

virtual bool IsPairedToAccount() const override

调用以确定设备当前是否与帐户配对。

允许重置

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

检查是否允许重置指定的配置。

细节
参数
[in] resetFlags
指定要重置的配置的标志。
返回值
TRUE
如果允许重置配置。
FALSE
如果不允许重置配置。

OnConnectionMonitor 超时

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 或特定于平台的错误代码表示发生了阻止故障安全解除武装的错误。

平台事件

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

表示远程被动会合进程已完成。

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

表示远程被动会合进程已启动。

重置配置

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

重置全部或部分设备配置。

根据重置标志,此功能的实现有望将网络、Weave 结构或服务配置的任何组合重置为已知状态。

细节
参数
[in] resetFlags
指定要重置的配置的标志。
返回值
WEAVE_NO_ERROR
关于成功。
other
其他 Weave 或特定于平台的错误代码表明发生了错误,阻止设备重置其配置。

系统测试开始

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 或平台特定的错误代码,表明在准备启动 Remote Passive Rendezvous 时发生错误。

受保护的功能

设备控制服务器

 DeviceControlServer()=default

设备控制服务器

 DeviceControlServer(
  const DeviceControlServer &
)=delete

设备控制服务器

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

运算符=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~设备控制服务器

 ~DeviceControlServer()=default