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

Esta es una clase abstracta.

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

Delega la clase para implementar operaciones entrantes de Control de dispositivos en el dispositivo del servidor.

Resumen

Herencia

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 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 monitor de conexión.
OnFailSafeArmed(void)=0
virtual WEAVE_ERROR
Indica que se activó la función de seguridad ante fallas de la configuración del dispositivo.
OnFailSafeDisarmed(void)=0
virtual WEAVE_ERROR
Indica que se desactivó la protección contra fallas de la configuración del dispositivo.
OnRemotePassiveRendezvousDone(void)=0
virtual void
Indica que finalizó el proceso de Rendezvous remoto.
OnRemotePassiveRendezvousStarted(void)=0
virtual void
Indica que se inició el proceso de Rendezvous remoto.
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 el servidor, si existe, antes de restablecer la configuración.
WillCloseRemotePassiveRendezvous(void)=0
virtual void
Prepárate para detener el encuentro pasivo remoto.
WillStartRemotePassiveRendezvous(void)=0
virtual WEAVE_ERROR
Prepárate para un encuentro pasivo remoto.

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 DeviceControl entrante

Detalles
Parámetros
[in] ec
Es el ExchangeContext mediante el cual se recibió el mensaje.
[in] msgProfileId
El ID de perfil del mensaje recibido.
[in] msgType
El tipo de mensaje recibido.
[in] msgInfo
Una estructura de 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. Cuando se ingresa al método, el valor representa el resultado tentativo en el punto actual del proceso de evaluación. Cuando se muestra, se espera que el resultado represente la evaluación final de la política de control de acceso para el 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 que se muestran
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 monitor de conexión.

Se llama a esta función cuando se produce un tiempo de espera del supervisor de conexión, es decir, cuando no se detectan verificaciones de actividad del host remoto durante un período determinado.

Detalles
Parámetros
[in] peerNodeId
El ID de nodo del intercambio de tráfico remoto con el que se agotó el tiempo de espera de la conexión.
[in] peerAddr
Es la dirección del par remoto.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

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

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

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Indica que finalizó el proceso de Rendezvous remoto.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Indica que se inició el proceso de Rendezvous remoto.

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

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

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

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

Prepárate para detener el encuentro pasivo remoto.

Consulta también:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

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