nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Esta es una clase abstracta.

#include <src/lib/profiles/device-control/DeviceControl.h>

Delegación de clase para implementar operaciones entrantes de Control de dispositivos en el dispositivo del servidor.

Resumen

Herencia

Se hereda de: nl::Weave::WeaveServerDelegateBase
Subclases conocidas directas: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Funciones públicas

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Aplicar el control de acceso a nivel del mensaje para un mensaje de solicitud de DeviceControl entrante
IsPairedToAccount() const
virtual bool
Se llama para determinar si el dispositivo está vinculado con una cuenta.
IsResetAllowed(uint16_t resetFlags)=0
virtual bool
Verifica si se permite restablecer la configuración especificada.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0
virtual void
Indica que se agotó el tiempo de espera del supervisor de conexión.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Indica que se activó la configuración del dispositivo de seguridad contra fallas.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Indica que se desactivó la configuración del dispositivo de seguridad contra fallas.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Indica que finalizó el proceso de Rendezvous remoto pasivo.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Indica que se inició el proceso de Rendezvous remoto pasivo.
OnResetConfig(uint16_t resetFlags)=0
virtual WEAVE_ERROR
Restablece toda la configuración del dispositivo o parte de ella.
OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0
virtual WEAVE_ERROR
Inicia la prueba del sistema especificada.
OnSystemTestStopped(void)=0
virtual WEAVE_ERROR
Detén la prueba del sistema en curso.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0
virtual bool
Determina si se debe cerrar una conexión con un servidor, si está presente, antes de restablecer la configuración.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Prepárate para detener Rendezvous remoto pasivo.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Prepárate para un encuentro remoto pasivo.

Funciones públicas

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Aplicar el control de acceso a nivel del mensaje para un mensaje de solicitud de DeviceControl entrante

Detalles
Parámetros
[in] ec
El ExchangeContext a través del cual se recibió el mensaje.
[in] msgProfileId
El ID de perfil del mensaje recibido.
[in] msgType
El tipo de mensaje del mensaje recibido.
[in] msgInfo
Una estructura WeaveMessageInfo que contiene información sobre el mensaje recibido.
[in,out] result
Un valor enumerado que describe el resultado de la evaluación de la política de control de acceso para el mensaje recibido. Al ingresar al método, el valor representa el resultado tentativo en el punto actual del proceso de evaluación. Tras regresar, se espera que el resultado represente la evaluación final de la política de control de acceso del mensaje.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

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

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

Indica que se agotó el tiempo de espera del supervisor de conexión.

Se llama a esta función cuando se agota el tiempo de espera del supervisor de conexiones, es decir, cuando no se detectan verificaciones de funcionamiento desde el host remoto durante un período determinado.

Detalles
Parámetros
[in] peerNodeId
El ID del nodo del par remoto para el cual se agotó el tiempo de espera de la conexión.
[in] peerAddr
La dirección del par remoto.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

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
)=0

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.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Indica que finalizó el proceso de Rendezvous remoto pasivo.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

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
)=0

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
)=0

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
)=0

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
)=0

Prepárate para detener Rendezvous remoto pasivo.

También:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

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.