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

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

Implementa el perfil de control de dispositivos de Weave para un dispositivo de Weave.

Resumen

Herencia

Hereda de:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Funciones públicas

Init()
IsPairedToAccount() const override
virtual bool
Se llama para determinar si el dispositivo está vinculado con una cuenta.
IsResetAllowed(uint16_t resetFlags) override
virtual bool
Verifica si se permite restablecer la configuración especificada.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
Indica que se activó la función de seguridad ante fallas de la configuración del dispositivo.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
Indica que se desactivó la protección contra fallas de la configuración del dispositivo.
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
Indica que finalizó el proceso de Rendezvous remoto.
OnRemotePassiveRendezvousStarted(void) override
virtual void
Indica que se inició el proceso de Rendezvous remoto.
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
Restablece toda la configuración del dispositivo o parte de ella.
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
Inicia la prueba del sistema especificada.
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
Detén la prueba del sistema en curso.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
Determina si se debe cerrar una conexión con el servidor, si existe, antes de restablecer la configuración.
WillCloseRemotePassiveRendezvous(void) override
virtual void
Prepárate para detener el encuentro pasivo remoto.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
Prepárate para un encuentro pasivo remoto.

Funciones protegidas

DeviceControlServer()=default
DeviceControlServer(const DeviceControlServer &)=delete
DeviceControlServer(const DeviceControlServer &&)=delete
operator=(const DeviceControlServer &)=delete
~DeviceControlServer()=default

Funciones públicas

Init

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

Se llama para determinar si el dispositivo está vinculado con una cuenta.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

Verifica si se permite restablecer la configuración especificada.

Detalles
Parámetros
[in] resetFlags
Las marcas que especifican qué configuración se debe restablecer.
Valores que se muestran
TRUE
si se permite restablecer la configuración.
FALSE
si no se permite restablecer la configuración.

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

Indica que se activó la función de seguridad ante fallas de la configuración del dispositivo.

Se llama a esta función cuando la configuración del dispositivo del dispositivo del servidor se activó en respuesta a una solicitud del cliente. La seguridad ante fallas restablece automáticamente la configuración del dispositivo a un estado conocido en caso de que el proceso de configuración no se complete correctamente.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
other
Otros códigos de error específicos de la plataforma o de Weave que indiquen que se produjo un error que impedía la activación del mecanismo de seguridad ante fallas

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

Indica que se desactivó la protección contra fallas de la configuración del dispositivo.

Se llama a esta función cuando la configuración del dispositivo del servidor se desactivó en respuesta a una solicitud del cliente. El cliente desactivará el mecanismo de seguridad ante fallas después de que se complete la configuración.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
other
Otros códigos de error específicos de la plataforma o de Weave que indiquen que se produjo un error que impedía la desactivación de la protección contra fallas

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

Indica que finalizó el proceso de Rendezvous remoto.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

Indica que se inició el proceso de Rendezvous remoto.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

Restablece toda la configuración del dispositivo o parte de ella.

Se espera que la implementación de esta función restablezca cualquier combinación de configuración de red, tejido de Weave o configuración de servicio a un estado conocido, de acuerdo con los indicadores de restablecimiento.

Detalles
Parámetros
[in] resetFlags
Las marcas que especifican qué configuración se debe restablecer.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
other
Otros códigos de error específicos de la plataforma o de Weave que indiquen que se produjo un error que impedía que el dispositivo restableciera su configuración

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

Inicia la prueba del sistema especificada.

Detalles
Parámetros
[in] profileId
Es el ID del perfil de la prueba solicitada.
[in] testId
Es el ID de la prueba solicitada.
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
other
Otros códigos de error específicos de la plataforma o de Weave que indiquen que se produjo un error que impedía el inicio de la prueba del sistema.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

Detén la prueba del sistema en curso.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
other
Otros códigos de error específicos de la plataforma o de Weave que indiquen que se produjo un error que impedía que se detuviera la prueba del sistema

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

Determina si se debe cerrar una conexión con el servidor, si existe, antes de restablecer la configuración.

Esta función se usa para consultar al delegado el comportamiento deseado cuando se procesa una solicitud de restablecimiento de la configuración. Si una conexión de servidor está activa en este momento, la respuesta TRUE a este método hará que se cierre esa conexión antes de que se active el restablecimiento de la configuración con el método OnResetConfig.

Detalles
Parámetros
[in] resetFlags
Las marcas que especifican qué configuración se debe restablecer.
Valores que se muestran
true
si es necesario cerrar la conexión.
false
si no es necesario cerrar la conexión.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

Prepárate para detener el encuentro pasivo remoto.

Consulta también:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

Prepárate para un encuentro pasivo remoto.

Por ejemplo, haz que se pueda unir la red 15.4/Thread.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
Si la operación es exitosa.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error durante la preparación para iniciar el Rendezvous remoto pasivo

Funciones protegidas

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operador=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default