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

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

Implementa el perfil de Weave Device Control para un dispositivo de Weave.

Resumen

Herencia

Se 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 configuración del dispositivo de seguridad contra fallas.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
Indica que se desactivó la configuración del dispositivo de seguridad contra fallas.
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
Indica que finalizó el proceso de Rendezvous remoto pasivo.
OnRemotePassiveRendezvousStarted(void) override
virtual void
Indica que se inició el proceso de Rendezvous remoto pasivo.
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 un servidor, si está presente, antes de restablecer la configuración.
WillCloseRemotePassiveRendezvous(void) override
virtual void
Prepárate para detener Rendezvous remoto pasivo.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
Prepárate para un encuentro remoto pasivo.

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 de retorno
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 configuración del dispositivo de seguridad contra fallas.

Se llama a esta función cuando la configuración de seguridad del dispositivo del servidor se activó en respuesta a una solicitud del cliente. La caja fuerte 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 de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió la activación del mecanismo de seguridad.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

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

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

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió la desactivación de la seguridad ante fallas.

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

Indica que finalizó el proceso de Rendezvous remoto pasivo.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

Indica que se inició el proceso de Rendezvous remoto pasivo.

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 configuraciones de red, tejido de Weave o servicio a un estado conocido, según las marcas de restablecimiento.

Detalles
Parámetros
[in] resetFlags
Las marcas que especifican qué configuración se debe restablecer.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió que el dispositivo restablezca 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
El ID del perfil de la prueba solicitada.
[in] testId
El ID de la prueba solicitada.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió el inicio de la prueba del sistema.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

Detén la prueba del sistema en curso.

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió la detención de la prueba del sistema.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

Determina si se debe cerrar una conexión con un servidor, si está presente, antes de restablecer la configuración.

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

Detalles
Parámetros
[in] resetFlags
Las marcas que especifican qué configuración se debe restablecer.
Valores de retorno
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 Rendezvous remoto pasivo.

También:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

Prepárate para un encuentro remoto pasivo.

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

Detalles
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
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 Rendezvous remoto pasivo.

Funciones protegidas

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default