nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningDelegate

Il s'agit d'une classe abstraite.

#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>

Classe déléguée pour la mise en œuvre des opérations de provisionnement réseau.

Résumé

Héritage

Hérite de : nl::Weave::WeaveServerDelegateBase
Sous-classes directes connues :
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::WeaveServer:DeviceLayer::Internal:DeviceLayer:

Attributs publics
Server
[LECTURE SEULE] Objet serveur auquel ce délégué est associé.

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 un message de demande de provisionnement réseau entrant.
HandleAddNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Ajoutez un réseau spécifique.
HandleDisableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Désactive le réseau spécifié.
HandleEnableNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
Active le réseau spécifié.
HandleGetNetworks(uint8_t flags)=0
virtual WEAVE_ERROR
Obtenez les réseaux configurés.
HandleGetWirelessRegulatoryConfig(void)
virtual WEAVE_ERROR
Obtenez des informations sur la configuration réglementaires des réseaux sans fil.
HandleRemoveNetwork(uint32_t networkId)=0
virtual WEAVE_ERROR
supprimer un réseau configuré ;
HandleScanNetworks(uint8_t networkType)=0
virtual WEAVE_ERROR
Effectuez une analyse de réseau.
HandleSetRendezvousMode(uint16_t rendezvousMode)=0
virtual WEAVE_ERROR
Définissez le mode Rendez-vous.
HandleSetWirelessRegulatoryConfig(PacketBuffer *regConfigTLV)
virtual WEAVE_ERROR
Définissez les informations de configuration réglementaires pour les réseaux sans fil.
HandleTestConnectivity(uint32_t networkId)=0
virtual WEAVE_ERROR
Testez la connectivité du réseau spécifié.
HandleUpdateNetwork(PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Mettre à jour la configuration d'un réseau
IsPairedToAccount() const
virtual bool
Appelée pour déterminer si l'appareil est actuellement associé à un compte.

Attributs publics

Serveur

NetworkProvisioningServer * Server

[LECTURE SEULE] Objet serveur auquel ce délégué est associé.

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 un message de demande de provisionnement réseau entrant.

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.

HandleAddNetwork

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

Ajoutez un réseau spécifique.

Détails
Paramètres
[in] networkInfoTLV
La configuration réseau encodée en TLV.
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'appareil d'ajouter le réseau
Consultez également la section
NetworkProvisioningDataElementTags pour connaître les types valides.

HandleDisableNetwork

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

Désactive le réseau spécifié.

Détails
Paramètres
[in] networkId
ID du réseau à désactiver.
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 désactiver le réseau

HandleEnableNetwork

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

Active le réseau spécifié.

Détails
Paramètres
[in] networkId
Identifiant du réseau à activer.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite et qu'il a empêché l'appareil d'activer le réseau.

HandleGetNetworks

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

Obtenez les réseaux configurés.

Détails
Paramètres
[in] flags
Indicateurs permettant de filtrer les réseaux récupérés.
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'appareil de se connecter aux réseaux configurés

HandleGetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

Obtenez des informations sur la configuration réglementaires des réseaux sans fil.

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 et qu'il a empêché l'appareil de récupérer les informations demandées.

HandleRemoveNetwork

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

supprimer un réseau configuré ;

Détails
Paramètres
[in] networkId
ID du réseau à supprimer.
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 supprimer le réseau

HandleScanNetworks

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

Effectuez une analyse de réseau.

Détails
Paramètres
[in] networkType
Technologie (Wi-Fi ou Thread, par exemple) à rechercher.
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'appareil d'effectuer une analyse du réseau
Consultez également la section
NetworkType pour connaître les types valides.

HandleSetRendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

Définissez le mode Rendez-vous.

Détails
Paramètres
[in] rendezvousMode
Le mode Rendez-vous à utiliser.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite et qu'il a empêché l'appareil de définir le mode rendez-vous.
Voir aussi:
RendezvousModeFlags pour connaître les modes valides.

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

Définissez les informations de configuration réglementaires pour les réseaux sans fil.

Détails
Paramètres
[in] regConfigTLV
Tampon de paquets contenant les nouvelles informations de configuration réglementaires sans fil encodées au format TLV.
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 définir les informations demandées

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

Testez la connectivité du réseau spécifié.

Détails
Paramètres
[in] networkId
ID du réseau dont vous souhaitez tester la connectivité.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
D'autres codes d'erreur Weave ou spécifiques à la plate-forme indiquant qu'une erreur s'est produite et empêchant l'appareil de tester la connectivité

HandleUpdateNetwork

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

Mettre à jour la configuration d'un réseau

Détails
Paramètres
[in] networkInfoTLV
La configuration réseau encodée en TLV.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
other
Autres codes d'erreur spécifiques à la plate-forme ou Weave indiquant qu'une erreur s'est produite et qu'il a empêché l'appareil de mettre à jour le réseau.
Consultez également la section
NetworkProvisioningDataElementTags pour connaître les types valides.

IsPairedToAccount

virtual bool IsPairedToAccount() const

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