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

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

Implémente le profil Weave Device Control pour un appareil Weave.

Résumé

Héritage

Hérite de:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

Fonctions publiques

Init()
IsPairedToAccount() const override
virtual bool
Appelée pour déterminer si l'appareil est actuellement couplé à un compte.
IsResetAllowed(uint16_t resetFlags) override
virtual bool
Vérifiez si la réinitialisation de la configuration spécifiée est autorisée.
OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed(void) override
virtual WEAVE_ERROR
Indiquez que la sécurité intégrée a été activée pour la configuration de l'appareil.
OnFailSafeDisarmed(void) override
virtual WEAVE_ERROR
Indiquer que la sécurité intégrée a été désactivée pour la configuration de l'appareil.
OnPlatformEvent(const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone(void) override
virtual void
Indique que le processus Rendezvous passif distant est terminé.
OnRemotePassiveRendezvousStarted(void) override
virtual void
Indique que le processus Rendezvous passif distant a démarré.
OnResetConfig(uint16_t resetFlags) override
virtual WEAVE_ERROR
Réinitialisez tout ou partie de la configuration de l'appareil.
OnSystemTestStarted(uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
Démarre le test système spécifié.
OnSystemTestStopped(void) override
virtual WEAVE_ERROR
Arrêtez le test du système en cours.
ShouldCloseConBeforeResetConfig(uint16_t resetFlags) override
virtual bool
Déterminez si une connexion au serveur, le cas échéant, doit être fermée avant une réinitialisation de la configuration.
WillCloseRemotePassiveRendezvous(void) override
virtual void
Préparez-vous à arrêter les rendez-vous passifs distants.
WillStartRemotePassiveRendezvous(void) override
virtual WEAVE_ERROR
Préparez-vous à un rendez-vous passif distant.

Fonctions protégées

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

Fonctions publiques

Init

WEAVE_ERROR Init()

IsPairedToAccount

virtual bool IsPairedToAccount() const override

Appelée pour déterminer si l'appareil est actuellement couplé à un compte.

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

Vérifiez si la réinitialisation de la configuration spécifiée est autorisée.

Détails
Paramètres
[in] resetFlags
Les indicateurs spécifiant la configuration à réinitialiser.
Valeurs renvoyées
TRUE
si la réinitialisation de la configuration est autorisée.
FALSE
si la réinitialisation de la configuration n'est pas autorisée.

OnConnectionMonitorTimeout

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

Indiquez que la sécurité intégrée a été activée pour la configuration de l'appareil.

Cette fonction est appelée lorsque la sécurité intégrée au serveur a été activée en réponse à une requête du client. La fonctionnalité de sécurité rétablit automatiquement la configuration de l'appareil à un état connu si le processus de configuration ne s'est pas terminé correctement.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
other
Autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite empêchant l'activation de la sécurité intégrée.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

Indiquer que la sécurité intégrée a été désactivée pour la configuration de l'appareil.

Cette fonction est appelée lorsque la sécurité de la configuration de l'appareil du serveur a été désactivée en réponse à une requête du client. Le client désactivera le dispositif de sécurité une fois la configuration terminée.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
other
Autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite empêchant la désactivation de la sécurité intégrée.

OnPlatformEvent

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
) override

Indique que le processus Rendezvous passif distant est terminé.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

Indique que le processus Rendezvous passif distant a démarré.

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

Réinitialisez tout ou partie de la configuration de l'appareil.

L'implémentation de cette fonction est censée rétablir un état connu de toute combinaison de configurations de réseau, de tissu tissé ou de configuration de service, en fonction des indicateurs de réinitialisation.

Détails
Paramètres
[in] resetFlags
Les indicateurs spécifiant la configuration à réinitialiser.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
other
Autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite empêchant la réinitialisation de l'appareil.

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

Démarre le test système spécifié.

Détails
Paramètres
[in] profileId
Identifiant du profil du test demandé.
[in] testId
Identifiant du test demandé.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
other
Autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite empêchant le démarrage du test système

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

Arrêtez le test du système en cours.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
other
Autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite empêchant l'arrêt du test système.

ShouldCloseConBeforeResetConfig

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

Déterminez si une connexion au serveur, le cas échéant, doit être fermée avant une réinitialisation de la configuration.

Cette fonction permet d'interroger le délégué et de lui demander le comportement souhaité lors du traitement d'une demande de réinitialisation de configuration. Si une connexion au serveur est actuellement active, une réponse TRUE à cette méthode entraînera la fermeture de cette connexion avant que la réinitialisation de la configuration ne soit déclenchée via la méthode OnResetConfig.

Détails
Paramètres
[in] resetFlags
Les indicateurs spécifiant la configuration à réinitialiser.
Valeurs renvoyées
true
si la connexion doit être fermée.
false
si la connexion n'a pas besoin d'être fermée.

WillCloseRemotePassiveRendezvous

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

Préparez-vous à arrêter les rendez-vous passifs distants.

Voir aussi:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

Préparez-vous à un rendez-vous passif distant.

Par exemple, faites en sorte que le réseau 15.4/Thread puisse être joint.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
other
Autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite lors de la préparation du démarrage de Rendezvous passif distant.

Fonctions protégées

DeviceControlServer

 DeviceControlServer()=default

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &
)=delete

DeviceControlServer

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

operator=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default