nl::Weave::Profiles::FabricProvisioning::FabricProvisioningServer

#include <src/lib/profiles/fabric-provisioning/FabricProvisioning.h>

Classe de serveur permettant d'implémenter le profil de provisionnement Fabric.

Résumé

Héritage

Hérite de: nl::Weave::WeaveServerBase
Sous-classes directes connues: nl::Weave::DeviceLayer::Internal::FabricProvisioningServer

Constructeurs et destructeurs

FabricProvisioningServer(void)

Attributs protégés

mCurClientOp
mDelegate

Fonctions publiques

Init(WeaveExchangeManager *exchangeMgr)
Initialisez l'état du serveur de provisionnement Fabric et enregistrez-le pour recevoir les messages de provisionnement Fabric.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Envoyez une réponse de rapport d'état à une requête.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Envoi d'une réponse positive à une requête de provisionnement Fabric
SessionHasFabricConfigAccessPrivilege(uint16_t keyId, uint64_t peerNodeId) const
bool
Indique si la session avec l'ID de nœud donné et l'ID de clé de session est autorisée à récupérer les informations de configuration de la structure.
SetDelegate(FabricProvisioningDelegate *delegate)
void
Définissez le délégué pour qu'il traite les événements de provisionnement de Fabric.
Shutdown(void)
Arrêtez le serveur de provisionnement Fabric.

Attributs protégés

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

FabricProvisioningDelegate * mDelegate

Fonctions publiques

FabricProvisioningServer

 FabricProvisioningServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialisez l'état du serveur de provisionnement Fabric et enregistrez-le pour recevoir les messages de provisionnement Fabric.

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

SendStatusReport

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

Envoyez une réponse de rapport d'état à une requête.

Détails
Paramètres
[in] statusProfileId
ID du profil Weave auquel ce rapport d'état se rapporte.
[in] statusCode
Code d'état à inclure dans cette réponse.
[in] sysError
Code d'erreur système à inclure dans cette réponse.
Valeurs de retour
WEAVE_ERROR_INCORRECT_STATE
Si aucune demande n'est en cours de traitement.
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'envoi du rapport d'état

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Envoi d'une réponse positive à une requête de provisionnement Fabric

Détails
Valeurs de retour
WEAVE_ERROR_INCORRECT_STATE
Si aucune demande n'est en cours de traitement.
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'envoi de la réponse positive

SessionHasFabricConfigAccessPrivilege

bool SessionHasFabricConfigAccessPrivilege(
  uint16_t keyId,
  uint64_t peerNodeId
) const 

Indique si la session avec l'ID de nœud donné et l'ID de clé de session est autorisée à récupérer les informations de configuration de la structure.

Détails
Renvoie
Renvoie la valeur "true" si le pair donné est privilégié. Sinon, la valeur "false" est renvoyée.

SetDelegate

void SetDelegate(
  FabricProvisioningDelegate *delegate
)

Définissez le délégué pour qu'il traite les événements de provisionnement de Fabric.

Détails
Paramètres
[in] delegate
Pointeur vers le délégué de provisionnement Fabric.

Arrêt

WEAVE_ERROR Shutdown(
  void
)

Arrêtez le serveur de provisionnement Fabric.

Détails
Valeurs de retour
WEAVE_NO_ERROR
sans conditions.