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 permettant d'implémenter des opérations de contrôle de périphériques entrantes 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 des 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 associé à 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'un délai d'inactivité de la surveillance des connexions s'est produit.
`OnFailSafeArmed(void)=0`	`virtual WEAVE_ERROR` Indique que la configuration de sécurité de l'appareil a été activée.
`OnFailSafeDisarmed(void)=0`	`virtual WEAVE_ERROR` Indique que la configuration de la fonctionnalité de sécurité défaillante a été désactivée sur la configuration de l'appareil.
`OnRemotePassiveRendezvousDone(void)=0`	`virtual void` Indique que le processus des Rendez vous passifs distant est terminé.
`OnRemotePassiveRendezvousStarted(void)=0`	`virtual void` Indique que le processus des rendez-vous passifs à distance 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` Lance le test système spécifié.
`OnSystemTestStopped(void)=0`	`virtual WEAVE_ERROR` Arrête 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 de réinitialiser la configuration.
`WillCloseRemotePassiveRendezvous(void)=0`	`virtual void` Préparez-vous à arrêter les rendez-vous passifs à distance.
`WillStartRemotePassiveRendezvous(void)=0`	`virtual WEAVE_ERROR` Préparez-vous à un rendez-vous passif à distance.

Fonctions publiques

EnforceAccessControl

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

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

Détails

Paramètres

`[in] ec`	Contexte ExchangeContext dans 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`	Une 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. Lors de l'entrée dans la méthode, la valeur représente le résultat provisoire au stade actuel du processus d'évaluation. Lors du retour, le résultat est censé représenter l'évaluation finale de la stratégie de contrôle d'accès du message.

IsPairedToAccount

virtual bool IsPairedToAccount() const

Appelée pour déterminer si l'appareil est actuellement associé à 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 indicateurs spécifiant la configuration à réinitialiser.

Valeurs de retour

`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'un délai d'inactivité de la surveillance des connexions s'est produit.

Cette fonction est appelée lorsqu'un délai d'inactivité du moniteur de connexion s'est produit, c'est-à-dire lorsque les vérifications d'activité n'ont pas été détectées par l'hôte distant depuis un certain temps.

Détails

Paramètres

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

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Indique que la configuration de sécurité de l'appareil a été activée.

Cette fonction est appelée lorsque la protection contre l'échec de la configuration de l'appareil serveur a été activée en réponse à une requête du client. Si le processus de configuration échoue, la configuration de l'appareil est automatiquement rétablie à un état connu.

Détails

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`other`	D'autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite empêchant l'activation de la sécurité contre les défaillances

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Indique que la configuration de la fonctionnalité de sécurité défaillante a été désactivée sur la configuration de l'appareil.

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

Détails

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`other`	Autres codes d'erreur propres à la plate-forme ou Weave indiquant qu'une erreur s'est produite empêchant la désactivation de la sécurité contre les défaillances

OnRemotePassiveRendezvousDone

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Indique que le processus des Rendez vous passifs distant est terminé.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Indique que le processus des rendez-vous passifs à distance 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 doit rétablir un état connu de n'importe quelle combinaison de configurations réseau, Weave Fold ou de services, en fonction des indicateurs de réinitialisation.

Détails

Paramètres

[in] resetFlags

Les indicateurs spécifiant la configuration à réinitialiser.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`other`	D'autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite et empêchant l'appareil de réinitialiser sa configuration

OnSystemTestStarted

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

Lance le test système spécifié.

Détails

Paramètres

`[in] profileId`	ID du profil du test demandé.
`[in] testId`	ID du test demandé.

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`other`	D'autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite et empêchant le démarrage du test du système

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

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

Détails

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`other`	D'autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite empêchant l'arrêt du test du 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 de réinitialiser la configuration.

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

Détails

Paramètres

[in] resetFlags

Les indicateurs spécifiant la configuration à réinitialiser.

Valeurs de retour

`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 à distance.

Voir aussi:
WillStartRemotePassiveRendezvous(void)

WillStartRemotePassiveRendezvous

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

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

Par exemple, rendez le réseau 15.4/Thread joignable.

Détails

Valeurs de retour

`WEAVE_NO_ERROR`	Pour la réussite.
`other`	Autres codes d'erreur liés à Weave ou à la plate-forme indiquant qu'une erreur s'est produite lors de la préparation du démarrage des rendez-vous passifs à distance.