Cette page a été traduite par l'API Cloud Translation.

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

Il s'agit d'une classe abstraite.

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

Classe déléguée pour l'implémentation d'opérations entrantes de contrôle des appareils sur l'appareil serveur.

Résumé

Héritage

Hérite de: nl::Weave::WeaveServerDelegateBase
Sous-classes directes connues: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Fonctions publiques
`EnforceAccessControl(ExchangeContext ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo msgInfo, AccessControlResult & result)`	`virtual void` appliquer un contrôle d'accès au niveau des messages pour les messages de requête DeviceControl entrants ;
`IsPairedToAccount() const`	`virtual bool` Appelée pour déterminer si l'appareil est actuellement couplé à un compte.
`IsResetAllowed(uint16_t resetFlags)=0`	`virtual bool` Vérifiez si la réinitialisation de la configuration spécifiée est autorisée.
`OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)=0`	`virtual void` Indique qu'il y a eu un délai avant expiration du contrôle de connexion.
`OnFailSafeArmed(void)=0`	`virtual WEAVE_ERROR` Indiquer que la sécurité intégrée a été activée pour la configuration de l'appareil.
`OnFailSafeDisarmed(void)=0`	`virtual WEAVE_ERROR` Indiquer que la sécurité intégrée a été désactivée pour la configuration de l'appareil.
`OnRemotePassiveRendezvousDone(void)=0`	`virtual void` Indique que le processus Rendezvous passif distant est terminé.
`OnRemotePassiveRendezvousStarted(void)=0`	`virtual void` Indique que le processus Rendezvous passif distant a démarré.
`OnResetConfig(uint16_t resetFlags)=0`	`virtual WEAVE_ERROR` Réinitialisez tout ou partie de la configuration de l'appareil.
`OnSystemTestStarted(uint32_t profileId, uint32_t testId)=0`	`virtual WEAVE_ERROR` Démarre le test système spécifié.
`OnSystemTestStopped(void)=0`	`virtual WEAVE_ERROR` Arrêtez le test du système en cours.
`ShouldCloseConBeforeResetConfig(uint16_t resetFlags)=0`	`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)=0`	`virtual void` Préparez-vous à arrêter les rendez-vous passifs distants.
`WillStartRemotePassiveRendezvous(void)=0`	`virtual WEAVE_ERROR` Préparez-vous à un rendez-vous passif distant.

Fonctions publiques

EnforceAccessControl

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

appliquer un contrôle d'accès au niveau des messages pour les messages de requête DeviceControl entrants ;

Détails

Paramètres

`[in] ec`	Le ExchangeContext sur lequel le message a été reçu.
`[in] msgProfileId`	ID de profil du message reçu.
`[in] msgType`	Type du message reçu.
`[in] msgInfo`	Structure WeaveMessageInfo contenant des informations sur le message reçu.
`[in,out] result`	Valeur énumérée décrivant le résultat de l'évaluation de la stratégie de contrôle d'accès pour le message reçu. Lorsque vous entrez dans la méthode, la valeur représente le résultat provisoire au stade actuel du processus d'évaluation. Une fois renvoyé, le résultat devrait représenter l'évaluation finale de la stratégie de contrôle des accès pour le message.

IsPairedToAccount

virtual bool IsPairedToAccount() const

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

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

Détails

Paramètres

[in] resetFlags

Les options 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

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

Indique qu'il y a eu un délai avant expiration du contrôle de connexion.

Cette fonction est appelée lorsqu'un délai avant expiration du contrôle des connexions s'est produit, c'est-à-dire lorsque les vérifications d'activité n'ont pas été détectées depuis l'hôte distant pendant un certain temps.

Détails

Paramètres

`[in] peerNodeId`	ID du nœud du pair distant pour lequel l'activité de la connexion a expiré.
`[in] peerAddr`	Adresse du pair distant.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Indiquer 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. Cette fonctionnalité 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
)=0

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.

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Indique que le processus Rendezvous passif distant est terminé.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

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

OnResetConfig

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

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

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

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

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

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

Voir aussi:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

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.