nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager

#include <src/lib/profiles/service-directory/ServiceDirectory.h>

L'objet gestionnaire de l'annuaire du service Weave.

Résumé

Le gestionnaire de service Weave est l'interface principale des applications au service d'annuaire. Il masque ainsi les complications inhérentes à la recherche de l'entrée de l'annuaire associée à un point de terminaison de service, à la recherche DNS sur un ou plusieurs des noms d'hôtes trouvés, à la tentative de connexion, à la sécurisation de la connexion, etc. Il peut également gérer un cache d'informations de répertoire de services.

Constructeurs et destructeurs

WeaveServiceManager(void)
Cette méthode initialise l'instance WeaveServiceManager.
~WeaveServiceManager(void)
Cette méthode détruit l'instance WeaveServiceManager.

Types publics

@303{
  kWeave_DefaultSendTimeout = 15000
}
énum
OnConnectBegin)(struct ServiceConnectBeginArgs &args) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnConnectBegin
void(*
Rappel d'application effectué immédiatement avant l'établissement de la connexion.
OnServiceEndpointQueryBegin)(void) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryBegin
void(*
Un rappel d'application pour marquer l'heure d'une requête sortante d'annuaire de services.
OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryEndWithTimeInfo
void(*
Rappel d'application pour fournir des valeurs temporelles à partir d'une réponse de répertoire de services.
RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::RootDirectoryAccessor
Fonction d'accès aux informations du répertoire racine.
StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::StatusHandler
void(*
Un gestionnaire pour les conditions d'erreur et d'état.

Fonctions publiques

SetConnectBeginCallback(OnConnectBegin aConnectBegin)
void
Définissez une fonction de rappel à appeler immédiatement avant l'établissement de la connexion.
cancel(uint64_t aServiceEp, void *aAppState)
void
Cette méthode annule une demande d'association.
clearCache(void)
void
Cette méthode efface l'état et le cache du gestionnaire si l'état est dans l'état terminal kServiceMgrState_Resolved, ce qui signifie que la réponse du point de terminaison de l'annuaire des services a été reçue.
connect(uint64_t aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnectIntf)
Cette méthode demande à se connecter à un service Weave.
init(WeaveExchangeManager *aExchangeMgr, uint8_t *aCache, uint16_t aCacheLen, RootDirectoryAccessor aAccessor, WeaveAuthMode aDirAuthMode, OnServiceEndpointQueryBegin aServiceEndpointQueryBegin, OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo, OnConnectBegin aConnectBegin)
Cette méthode initialise l'objet Service Manager.
lookup(uint64_t aServiceEp, HostPortList *outHostPortList)
Cette méthode recherche des informations de répertoire pour un point de terminaison de service.
lookup(uint64_t aServiceEp, uint8_t *aControlByte, uint8_t **aDirectoryEntry)
Cette méthode recherche les informations d'annuaire pour un point de terminaison de service.
onConnectionClosed(WEAVE_ERROR aError)
void
Cette méthode gère l'événement de fermeture de connexion signalé par le contexte de l'échange Weave associé.
onConnectionComplete(WEAVE_ERROR aError)
void
Cette méthode gère l'événement de connexion terminée pour la transaction de requête du point de terminaison de service.
onResponseReceived(uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
Cette méthode gère tout message de réponse dans la conversation avec le service d'annuaire.
onResponseTimeout(void)
void
Cette méthode gère l'événement de délai avant expiration, dans lequel aucune réponse n'a été reçue du service d'annuaire.
relocate(WEAVE_ERROR aError)
void
Cette méthode déplace le cache de l'annuaire des services.
relocate(void)
void
Cette méthode déplace le cache de l'annuaire des services.
replaceOrAddCacheEntry(uint16_t port, const char *hostName, uint8_t hostLen, uint64_t serviceEndpointId)
Ajoutez l'entrée de remplacement d'un nom d'hôte et d'un ID de port au début de la liste des répertoires.
reset(WEAVE_ERROR aError)
void
Cette méthode rétablit l'état initial du gestionnaire de services.
reset(void)
void
Cette méthode rétablit l'état initial du gestionnaire de services.
unresolve(WEAVE_ERROR aError)
void
Cette méthode invalide le cache du répertoire de service.
unresolve(void)
void
Cette méthode invalide le cache de l'annuaire de services.

Classes

nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

Cette classe représente une seule transaction gérée par le Gestionnaire de services.

Types publics

@303

 @303
Propriétés
kWeave_DefaultSendTimeout

Nombre de millisecondes pendant lesquelles une réponse doit être reçue pour la requête de répertoire avant que le contexte d'échange n'expire.

OnConnectBegin

void(* OnConnectBegin)(struct ServiceConnectBeginArgs &args)

Rappel d'application effectué juste avant l'établissement de la connexion.

Ce rappel peut être utilisé par les applications pour observer et éventuellement modifier les arguments transmis à #WeaveConnection::Connect() lors de l'établissement d'une connexion de service. Ce rappel sera appelé à la fois pour la connexion au point de terminaison du service cible et pour la connexion au point de terminaison de l'annuaire des services si une recherche dans l'annuaire doit être effectuée.

OnServiceEndpointQueryBegin

void(* OnServiceEndpointQueryBegin)(void)

Un rappel d'application pour marquer l'heure d'une requête sortante d'annuaire de services.

Cette méthode est appelée lorsque nous sommes sur le point d'envoyer la requête de requête du point de terminaison du service. Utilisé pour mettre en correspondance avec OnServiceEndpointQueryEnd pour compenser le temps de vol des messages.

OnServiceEndpointQueryEndWithTimeInfo

void(* OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec)

Rappel d'application permettant de fournir des valeurs temporelles à partir d'une réponse de l'Annuaire des services.

Cette méthode est appelée lorsque nous obtenons des informations temporelles à partir de la réponse de la requête de l'annuaire des services. Notez que ce rappel ne se produit que si une réponse est correctement analysée et que des informations temporelles sont incluses.

Détails
Paramètres
[in] timeQueryReceiptMsec
Nombre de millisecondes écoulées depuis l'epoch POSIX, lorsque la requête a été reçue côté serveur.
[in] timeProcessMsec
Nombre de ms consacré au traitement de cette requête.

RootDirectoryAccessor

WEAVE_ERROR(* RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength)

Fonction d'accesseur pour les informations du répertoire racine.

Vous devez commencer quelque part et, avec le répertoire de service, vous devez commencer par un répertoire stub contenant l'adresse d'un serveur que vous pouvez utiliser pour obtenir tout le reste. Étant donné que la disposition et la provenance de ces informations sont susceptibles de varier d'un appareil à l'autre, nous fournissons ici un rappel d'accesseur.

Détails
Paramètres
[out] aDirectory
Pointeur vers une mémoire tampon pour écrire les informations de répertoire.
[in] aLength
Longueur du tampon donné en octets.
Renvoie
WEAVE_NO_ERROR en cas de réussite, sinon le processus de chargement est abandonné.

StatusHandler

void(* StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport)

Gestionnaire des conditions d'erreur et d'état.

Un utilisateur du Gestionnaire de services peut être informé des problèmes d'exécution d'une requête de connexion de deux manières. Il peut recevoir un rapport d'état du service ou une erreur WEAVE_ERROR générée en interne. Dans les deux cas, les informations proviennent de ce rappel.

Détails
Paramètres
[in] anAppState
Pointeur vers un objet d'application transmis à l'appel conect() correspondant.
[in] anError
Code d'erreur Weave indiquant qu'une erreur s'est produite lors de la tentative d'exécution de la requête de connexion. Il doit s'agir de WEAVE_NO_ERROR si aucune erreur ne s'est produite et qu'un rapport d'état est disponible.
[in] aStatusReport
Pointeur vers un rapport d'état généré par le service d'annuaire distant. Cet argument doit être NULL si aucun rapport d'état n'a été généré et qu'une erreur interne est transmise dans l'argument précédent.

Fonctions publiques

SetConnectBeginCallback

void SetConnectBeginCallback(
  OnConnectBegin aConnectBegin
)

Définissez une fonction de rappel à appeler immédiatement avant l'établissement de la connexion.

Détails
Paramètres
[in] aConnectBegin
Pointeur vers la fonction de rappel. Une valeur NULL désactive le rappel.

WeaveServiceManager

 WeaveServiceManager(
  void
)

Cette méthode initialise l'instance WeaveServiceManager.

Notez que init() doit être appelé pour initialiser davantage cette instance.

annuler

void cancel(
  uint64_t aServiceEp,
  void *aAppState
)

Cette méthode annule une demande de connexion.

Cette méthode annule une requête de connexion en fonction de l'ID du point de terminaison du service et de l'objet d'état de l'application transmis au moment de la requête en tant qu'identifiants. S'il s'agit de la dernière requête de connexion, cette méthode efface également tout état de connexion à l'annuaire de services en attente.

Détails
Paramètres
[in] aServiceEp
ID du point de terminaison de service de la requête en cours d'annulation.
[in] anAppState
Pointeur vers l'objet d'état de l'application fourni à l'appel connect().

clearCache

void clearCache(
  void
)

Cette méthode efface l'état et le cache du gestionnaire si l'état est dans l'état kServiceMgrState_Resolved du terminal, ce qui signifie que la réponse du point de terminaison de l'Annuaire des services a bien été reçue.

associer

WEAVE_ERROR connect(
  uint64_t aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnectIntf
)

Cette méthode demande à se connecter à un service Weave.

Il s'agit de l'appel de connexion de niveau supérieur. Il produit essentiellement une connexion sécurisée au service Weave en fonction d'un point de terminaison du service et d'un mode d'authentification, ou il ne fait pas de tentative.

Cette méthode ne peut être appelée qu'après un appel réussi à init(), et une demande de connexion peut être annulée par cancel().

Cette méthode peut être appelée avant que le cache local ne soit rempli de données à partir des données provisionnées par défaut ou d'un appel au service d'annuaire. Le gestionnaire de services met simplement la requête en file d'attente avant que le contenu du cache puisse être déterminé.

Détails
Paramètres
[in] aServiceEp
Identifiant du point de terminaison du service, tel que défini dans ServiceDirectory.h, pour le service qui vous intéresse.
[in] aAuthMode
Mode d'authentification à utiliser lors de la connexion au service de votre choix.
[in] aAppState
Pointeur vers un objet d'état de l'application, transmis aux rappels en tant qu'argument.
[in] aStatusHandler
Rappel à appeler en cas d'erreur avant la fin de la connexion.
[in] aConnectionCompleteHandler
Rappel à appeler lorsque la connexion demandée est terminée. Notez que la connexion peut échouer avec un code d'erreur Weave.
[in] aConnectTimeoutMsecs
Délai avant expiration de la connexion TCP facultative en millisecondes.
[in] aConnectIntf
Interface facultative sur laquelle la connexion doit être établie.
Renvoie
WEAVE_NO_ERROR en cas de réussite, sinon un code d'erreur correspondant.

init

WEAVE_ERROR init(
  WeaveExchangeManager *aExchangeMgr,
  uint8_t *aCache,
  uint16_t aCacheLen,
  RootDirectoryAccessor aAccessor,
  WeaveAuthMode aDirAuthMode,
  OnServiceEndpointQueryBegin aServiceEndpointQueryBegin,
  OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo,
  OnConnectBegin aConnectBegin
)

Cette méthode initialise l'objet du gestionnaire de services.

Pour être utilisé, un objet de gestionnaire de services doit être initialisé. Une fois l'appel de cette méthode réussi, les clients peuvent commencer à appeler connect(), lookup() et d'autres méthodes.

Détails
Paramètres
[in] aExchangeMgr
Pointeur vers le gestionnaire d'échange à utiliser pour tous les échanges de profils de répertoire de services.
[in] aCache
Pointeur vers un tampon qui peut être utilisé pour mettre en cache les informations du répertoire.
[in] aCacheLen
Longueur en octets du cache.
[in] aAccessor
Le rappel, tel que défini dans ServiceDirectory.h, à appeler pour charger le répertoire racine comme point de départ de la recherche de répertoire.
[in] aDirAuthMode
Mode d'authentification à utiliser lors de la communication avec le service d'annuaire.
[in] aServiceEndpointQueryBegin
Pointeur de fonction de type OnServiceEndpointQueryBegin, appelé au début d'une requête de répertoire de services et qui permet au code de l'application de marquer l'heure s'il souhaite utiliser la synchronisation temporelle proposée par le protocole de répertoire de services.
[in] aServiceEndpointQueryEndWithTimeInfo
Pointeur de fonction de type OnServiceEndpointQueryEndWithTimeInfo, appelé à la réception d'un répertoire de service permettant aux applications de se synchroniser avec le service Weave à l'aide des champs de temps indiqués dans la réponse. Ce rappel est effectué une fois que le gestionnaire de services a reçu une réponse contenant des informations temporelles. Le cache doit déjà être rempli avant l'appel du rappel.
[in] aConnectBegin
Pointeur de fonction de type OnConnectBegin, appelé immédiatement avant l'établissement de la connexion et qui permet aux applications d'observer et éventuellement de modifier les arguments transmis à #WeaveConnection::Connect(). Une valeur NULL (par défaut) désactive le rappel.
Renvoie
WEAVE_ERROR_INVALID_ARGUMENT si un argument de fonction n'est pas valide sinon, WEAVE_NO_ERROR.

lookup

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  HostPortList *outHostPortList
)

Cette méthode recherche les informations d'annuaire pour un point de terminaison de service.

Si le répertoire de service a été résolu, c'est-à-dire si une opération connect() s'est correctement déroulée, cette méthode insère l'objet HostPortList fourni.

Remarque : HostPortList est lié à l'objet WeaveServiceManager. Il reste valide jusqu'à ce que le cache du répertoire de services soit effacé ou qu'une autre recherche de répertoire de services soit effectuée.

Détails
Paramètres
[in] aServiceEp
Identifiant du point de terminaison du service à rechercher.
[out] outHostPortList
Pointeur vers HostPortList qui sera renseigné en cas de recherche réussie de l'entrée de répertoire. Ne doit pas être NULL.
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite, sinon un code d'erreur correspondant.
WEAVE_ERROR_INVALID_SERVICE_EP
si le point de terminaison du service donné est introuvable.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
si le répertoire contient un type d'entrée de répertoire inconnu.

lookup

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  uint8_t *aControlByte,
  uint8_t **aDirectoryEntry
)

Cette méthode recherche des informations de répertoire pour un point de terminaison de service.

Si l'annuaire du service a été résolu, c'est-à-dire si une opération connect() a abouti, cette méthode renvoie une entrée de répertoire en fonction d'un identifiant de point de terminaison du service.

Cette méthode expose les détails de l'implémentation interne de l'annuaire de services. Il est fortement recommandé d'utiliser la variante de cette méthode qui génère la liste HostPortList.

Détails
Paramètres
[in] aServiceEp
Identifiant du point de terminaison du service à rechercher.
[out] aControlByte
Pointeur vers l'emplacement où écrire l'octet de contrôle de l'entrée de l'annuaire.
[out] aDirectoryEntry
Pointeur à diriger vers l'entrée de répertoire.
Valeurs renvoyées
WEAVE_NO_ERROR
en cas de réussite, sinon un code d'erreur correspondant.
WEAVE_ERROR_INVALID_SERVICE_EP
si le point de terminaison du service donné est introuvable.
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
si le répertoire contient un type d'entrée de répertoire inconnu.

onConnectionClosed

void onConnectionClosed(
  WEAVE_ERROR aError
)

Cette méthode gère l'événement de connexion fermée signalé par le contexte d'échange Weave associé.

Détails
Paramètres
[in] aError
Erreur Weave indiquant la raison pour laquelle cette connexion doit être fermée.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Cette méthode gère l'événement de connexion terminée pour la transaction de requête du point de terminaison de service.

Plusieurs possibilités s'offrent à vous. Tout d'abord, la connexion aurait pu échouer, où nous avons terminé. Sinon, la connexion est terminée. Nous voulons ouvrir un contexte d'échange et envoyer une requête de répertoire.

Détails
Paramètres
[in] aError
Une erreur Weave si une erreur se produit lors de la configuration de la connexion.

onResponseReceived

void onResponseReceived(
  uint32_t aProfileId,
  uint8_t aMsgType,
  PacketBuffer *aMsg
)

Cette méthode gère tous les messages de réponse dans la conversation avec le service d'annuaire.

Détails
Paramètres
[in] aProfileId
ID de profil de ce message entrant.
[in] aMsgType
Type spécifique au profil de ce message.
[in] aMsg
Contenu de ce message.

onResponseTimeout

void onResponseTimeout(
  void
)

Cette méthode gère l'événement de délai avant expiration, dans lequel aucune réponse n'a été reçue du service d'annuaire.

déplacer

void relocate(
  WEAVE_ERROR aError
)

Cette méthode déplace le cache de l'annuaire des services.

Lorsqu'un point de terminaison de service renvoie un rapport d'état avec le code d'état kStatus_Relocalized, l'application peut appeler unresolve() pour vider le cache et annuler les demandes de connexion. Cette méthode simplifie la gestion des erreurs en appelant unresolve() pour la première fois, puis reset() si le problème n'est pas encore résolu.

Cette version de la méthode (ici pour assurer la rétrocompatibilité) enregistre une erreur, puis appelle relocate(void).

Détails
Paramètres
[in] aError
une erreur à consigner.
Voir aussi :
relocate(void)

déplacer

void relocate(
  void
)

Cette méthode déplace le cache du répertoire de service.

Lorsqu'un point de terminaison de service renvoie un rapport d'état avec le code d'état kStatus_Relocalized, l'application peut appeler unresolve() pour vider le cache et annuler les demandes de connexion. Cette méthode simplifie la gestion des erreurs en appelant unresolve() pour la première fois, puis reset() si le problème n'est pas encore résolu.

Voir aussi :
relocate(WEAVE_ERROR)

replaceOrAddCacheEntry

WEAVE_ERROR replaceOrAddCacheEntry(
  uint16_t port,
  const char *hostName,
  uint8_t hostLen,
  uint64_t serviceEndpointId
)

Ajoutez l'entrée de répertoire remplaçante d'un nom d'hôte et d'un ID de port au début de la liste de répertoires.

réinitialiser

void reset(
  WEAVE_ERROR aError
)

Cette méthode rétablit l'état initial du gestionnaire de services.

Cette méthode réinitialise tous les états du gestionnaire de service, y compris l'état des communications, l'état du cache et l'état des demandes de connexion en attente.

Cette version de la méthode (ici pour la rétrocompatibilité) reçoit et consigne une erreur, puis appelle reset(void).

Détails
Paramètres
[in] aError
Erreur ayant déclenché cette opération.
Voir aussi:
reset(void)

réinitialiser

void reset(
  void
)

Cette méthode rétablit l'état initial du gestionnaire de services.

Cette méthode réinitialise tous les états du gestionnaire de services, y compris l'état des communications, l'état du cache et l'état de toutes les requêtes de connexion en attente.

Voir également :
reset(WEAVE_ERROR)

non résolu

void unresolve(
  WEAVE_ERROR aError
)

Cette méthode invalide le cache du répertoire de service.

Cette méthode définit l'état du cache de l'annuaire de services de sorte que, lors de la prochaine requête, le gestionnaire de services émette une requête d'annuaire de services.

Cette version de la méthode, utilisée ici pour assurer la rétrocompatibilité, accepte et consigne une erreur, puis appelle unresolve(void) .

Détails
Paramètres
[in] aError
Erreur ayant déclenché cette opération.
Voir aussi :
unresolve(void)

non résolu

void unresolve(
  void
)

Cette méthode invalide le cache du répertoire de service.

Cette méthode définit l'état du cache de l'annuaire des services afin que, lors de la prochaine requête, le gestionnaire de services émette une requête d'annuaire des services.

Voir aussi:
unresolve(WEAVE_ERROR)

~WeaveServiceManager

 ~WeaveServiceManager(
  void
)

Cette méthode détruit l'instance WeaveServiceManager.