nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

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

Classe serveur permettant d'implémenter le profil de provisionnement du réseau.

Résumé

Héritage

Hérite de: nl::Weave::WeaveServerBase
Sous-classes directes connues:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl&lt; ImplClass >

Constructeurs et destructeurs
NetworkProvisioningServer(void)

Attributs protégés
mCurOp
mCurOpType
uint8_t
mDelegate
mLastOpResult
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217

Attributs publics
StatusCode
uint16_t
StatusProfileId
uint32_t
SysError

Fonctions publiques
Init(WeaveExchangeManager *exchangeMgr)
Initialisez l'état du serveur de provisionnement réseau et enregistrez-vous pour recevoir des messages de provisionnement réseau.
SendAddNetworkComplete(uint32_t networkId)
virtual WEAVE_ERROR
Si le réseau a bien été ajouté, envoyez un message.
SendGetNetworksComplete(uint8_t resultCount, PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envoyez un message "Get Networks Complete" (Obtenir les réseaux terminés) contenant les réseaux précédemment analysés.
SendGetWirelessRegulatoryConfigComplete(PacketBuffer *resultsTLV)
virtual WEAVE_ERROR
Envoyez un message GetWirelessRegulatoryConfigComplete au pair.
SendNetworkScanComplete(uint8_t resultCount, PacketBuffer *scanResultsTLV)
virtual WEAVE_ERROR
Envoyez un message de réponse Network Scan Complete contenant les résultats de l'analyse.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Envoyez un rapport d'état en réponse à une demande.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Envoyer une réponse positive à une requête de provisionnement du réseau
SetDelegate(NetworkProvisioningDelegate *delegate)
void
Définissez le délégué pour qu'il traite les événements du serveur de provisionnement réseau.
Shutdown(void)
Arrêtez le serveur de provisionnement réseau.

Attributs protégés

mCurOp

ExchangeContext * mCurOp

mCurOpType

uint8_t mCurOpType

mDelegate

NetworkProvisioningDelegate * mDelegate

mLastOpResult

struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult

Attributs publics

StatusCode

uint16_t StatusCode

StatusProfileId

uint32_t StatusProfileId

SysError

WEAVE_ERROR SysError

Fonctions publiques

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisez l'état du serveur de provisionnement réseau et enregistrez-vous pour recevoir des messages de provisionnement réseau.

Détails
Paramètres
[in] exchangeMgr
Pointeur vers le gestionnaire système Weave Exchange.
Valeurs renvoyées
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Si trop de gestionnaires de messages ont déjà été enregistrés.
WEAVE_NO_ERROR
En cas de réussite.

NetworkProvisioningServer

 NetworkProvisioningServer(
  void
)

SendAddNetworkComplete

virtual WEAVE_ERROR SendAddNetworkComplete(
  uint32_t networkId
)

Si le réseau a bien été ajouté, envoyez un message.

Détails
Paramètres
[in] networkId
ID du réseau ajouté.
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Si le serveur de provisionnement réseau n'est pas initialisé correctement.
WEAVE_ERROR_NO_MEMORY
En cas d'échec de l'allocation d'un PacketBuffer.
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'appareil d'envoyer le message "Add Network Complete" (Ajouter un réseau terminé).

SendGetNetworksComplete

virtual WEAVE_ERROR SendGetNetworksComplete(
  uint8_t resultCount,
  PacketBuffer *resultsTLV
)

Envoyez un message "Get Networks Complete" (Obtenir les réseaux terminés) contenant les réseaux précédemment analysés.

Détails
Paramètres
[in] resultCount
Nombre de résultats d'analyse.
[in] scanResultsTLV
Résultats de l'analyse
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Si le serveur de provisionnement réseau n'est pas initialisé correctement.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si le tampon des résultats n'est pas assez volumineux.
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'appareil d'envoyer le message Get Networks Complete.

SendGetWirelessRegulatoryConfigComplete

virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
  PacketBuffer *resultsTLV
)

Envoyez un message GetWirelessRegulatoryConfigComplete au pair.

Détails
Paramètres
[in] resultsTLV
Tampon de paquet contenant les informations de configuration réglementaire pour les réseaux sans fil à renvoyer.
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Si le serveur de provisionnement réseau n'est pas initialisé correctement.
WEAVE_ERROR_NO_MEMORY
En cas d'échec de l'allocation d'un PacketBuffer.
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'appareil d'envoyer le message "Add Network Complete" (Ajouter un réseau terminé).

SendNetworkScanComplete

virtual WEAVE_ERROR SendNetworkScanComplete(
  uint8_t resultCount,
  PacketBuffer *scanResultsTLV
)

Envoyez un message de réponse Network Scan Complete contenant les résultats de l'analyse.

Détails
Paramètres
[in] resultCount
Nombre de résultats d'analyse.
[in] scanResultsTLV
Résultats de l'analyse
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Si le serveur de provisionnement réseau n'est pas initialisé correctement.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si le tampon des résultats n'est pas assez volumineux.
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'appareil d'envoyer la réponse "Scan Complete".

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Envoyez un rapport d'état en réponse à une demande.

Détails
Paramètres
[in] statusProfileId
ID de profil Weave concerné par ce rapport d'état.
[in] statusCode
Code d'état à inclure dans cette réponse.
[in] sysError
Code d'erreur système à inclure dans cette réponse.
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Si aucune demande n'est en cours de traitement.
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'appareil d'envoyer le rapport d'état.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Envoyer une réponse positive à une requête de provisionnement du réseau

Détails
Valeurs renvoyées
WEAVE_ERROR_INCORRECT_STATE
Si aucune demande n'est en cours de traitement.
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'appareil d'envoyer la réponse de réussite.

SetDelegate

void SetDelegate(
  NetworkProvisioningDelegate *delegate
)

Définissez le délégué pour qu'il traite les événements du serveur de provisionnement réseau.

Détails
Paramètres
[in] delegate
Un pointeur vers le délégué de provisionnement du réseau.

Arrêt

WEAVE_ERROR Shutdown(
  void
)

Arrêtez le serveur de provisionnement réseau.

Détails
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.