Associer les métriques

Ce module inclut des fonctions de contrôle du protocole Link Metrics.

Résumé

Énumérations
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
Indicateurs ACK amélioré.
otLinkMetricsStatus enum
Associez les valeurs de l'état des métriques.

Typedefs
otLinkMetricsEnhAckFlags typedef
Indicateurs ACK amélioré.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
Le pointeur est appelé lorsque la vérification Enh-ACK d'IE est reçue.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Le pointeur est appelé lorsqu'une réponse de gestion des métriques de lien est reçue.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Le pointeur est appelé lors de la réception d'un rapport sur les métriques sur les liens.
otLinkMetricsSeriesFlags typedef
Représente les trames comptabilisées dans une série Forward Tracking.
otLinkMetricsStatus typedef
Associez les valeurs de l'état des métriques.
otLinkMetricsValues typedef
Représente le résultat (valeur) d'une requête de métriques sur les liens.

distantes
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
Envoie une requête de gestion des métriques de lien MLE pour configurer/effacer une vérification basée sur l'accusé de réception avancé.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Envoie une requête de gestion des métriques de lien MLE pour configurer ou effacer une série Forward Tracking.
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
Obtenir les données de métriques de liaison d'un voisin en fonction de son adresse étendue.
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
Activez ou désactivez le gestionnaire de métriques d'association.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
Envoie une requête de données MLE pour interroger les métriques de lien.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Envoie un message de vérification de lien MLE.

Structs
otLinkMetricsSeriesFlags

Représente les trames comptabilisées dans une série Forward Tracking.

otLinkMetricsValues

Représente le résultat (valeur) d'une requête de métriques sur les liens.

Énumérations

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

Indicateurs ACK amélioré.

Ils sont utilisés dans la vérification basée sur l'accusé de réception amélioré pour indiquer si la vérification doit être enregistrée ou effacée.

Propriétés
OT_LINK_METRICS_ENH_ACK_CLEAR

Claire.

OT_LINK_METRICS_ENH_ACK_REGISTER

S'inscrire

otLinkMetricsStatus

 otLinkMetricsStatus

Associez les valeurs de l'état des métriques.

Typedefs

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Indicateurs ACK amélioré.

Ils sont utilisés dans la vérification basée sur l'accusé de réception amélioré pour indiquer si la vérification doit être enregistrée ou effacée.

otLinkMetricsEnhAckProbingIeReportCallback

void(* otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext)

Le pointeur est appelé lorsque la vérification Enh-ACK d'IE est reçue.

Détails
Paramètres
[in] aShortAddress
Adresse courte Mac du sujet de la vérification.
[in] aExtAddress
Pointeur vers l'adresse étendue Mac du sujet examiné.
[in] aMetricsValues
Pointeur vers les valeurs des métriques de lien obtenues à partir d'IE.
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otLinkMetricsMgmtResponseCallback

void(* otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext)

Le pointeur est appelé lorsqu'une réponse de gestion des métriques de lien est reçue.

Détails
Paramètres
[in] aSource
Pointeur vers l'adresse source.
[in] aStatus
Code d'état dans la réponse.
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otLinkMetricsReportCallback

void(* otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext)

Le pointeur est appelé lors de la réception d'un rapport sur les métriques sur les liens.

Détails
Paramètres
[in] aSource
Pointeur vers l'adresse source.
[in] aMetricsValues
Un pointeur vers les valeurs des métriques de lien (résultat de la requête).
[in] aStatus
Code d'état dans le rapport (utile uniquement lorsque aMetricsValues est NULL).
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

Représente les trames comptabilisées dans une série Forward Tracking.

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

Associez les valeurs de l'état des métriques.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

Représente le résultat (valeur) d'une requête de métriques sur les liens.

distantes

otLinkMetricsConfigEnhAckProbing

otError otLinkMetricsConfigEnhAckProbing(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  otLinkMetricsEnhAckFlags aEnhAckFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext,
  otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback,
  void *aEnhAckCallbackContext
)

Envoie une requête de gestion des métriques de lien MLE pour configurer/effacer une vérification basée sur l'accusé de réception avancé.

Cette fonctionnalité nécessite l'activation de la fonctionnalité OT_LINK_METRICS_INITIATOR.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aEnhAckFlags
Indicateurs Enh-ACK pour indiquer s'il faut enregistrer ou effacer la vérification. 0 pour effacer et 1 pour enregistrer. Les autres valeurs sont réservées.
[in] aLinkMetricsFlags
Pointeur vers des options spécifiant les métriques à interroger. Doit être NULL lorsque aEnhAckFlags est 0.
[in] aCallback
Pointeur vers une fonction appelée lorsqu'un accusé de réception avancé avec des métriques de lien est reçu.
[in] aCallbackContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Le message de demande de gestion des métriques d'association a bien été envoyé.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer le message de requête de gestion des métriques de lien MLE.
OT_ERROR_INVALID_ARGS
aEnhAckFlags n'est pas une valeur valide ou aLinkMetricsFlags est incorrect.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination n'est pas de type liaison locale, ou le voisin est introuvable.
OT_ERROR_NOT_CAPABLE
Le voisin n'est pas un appareil Thread 1.2 et n'est pas compatible avec les métriques sur les liens.

otLinkMetricsConfigForwardTrackingSeries

otError otLinkMetricsConfigForwardTrackingSeries(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  otLinkMetricsSeriesFlags aSeriesFlags,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsMgmtResponseCallback aCallback,
  void *aCallbackContext
)

Envoie une requête de gestion des métriques de lien MLE pour configurer ou effacer une série Forward Tracking.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aSeriesId
ID de série à utiliser.
[in] aSeriesFlags
Indicateurs de série qui spécifient les images qui doivent être prises en compte.
[in] aLinkMetricsFlags
Pointeur vers des options spécifiant les métriques à interroger. Doit être NULL lorsque aSeriesFlags est 0.
[in] aCallback
Pointeur vers une fonction appelée lorsque la réponse de gestion des métriques de lien est reçue.
[in] aCallbackContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Le message de demande de gestion des métriques d'association a bien été envoyé.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer le message de requête de gestion des métriques de lien MLE.
OT_ERROR_INVALID_ARGS
aSeriesId n'est pas dans la plage valide.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination n'est pas de type liaison locale, ou le voisin est introuvable.
OT_ERROR_NOT_CAPABLE
Le voisin n'est pas un appareil Thread 1.2 et n'est pas compatible avec les métriques sur les liens.

otLinkMetricsManagerGetMetricsValueByExtAddr

otError otLinkMetricsManagerGetMetricsValueByExtAddr(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  otLinkMetricsValues *aLinkMetricsValues
)

Obtenir les données de métriques de liaison d'un voisin en fonction de son adresse étendue.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aExtAddress
Pointeur vers l'adresse étendue Mac du sujet examiné.
[out] aLinkMetricsValues
Pointeur vers les valeurs des métriques sur les liens de l'objet.
Valeurs de retour
OT_ERROR_NONE
Les données concernant les métriques sur les liens ont bien été obtenues.
OT_ERROR_INVALID_ARGS
Les arguments ne sont pas valides.
OT_ERROR_NOT_FOUND
Aucun voisin trouvé avec l'adresse étendue indiquée.

otLinkMetricsManagerSetEnabled

void otLinkMetricsManagerSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Activez ou désactivez le gestionnaire de métriques d'association.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnable
Booléen indiquant d'activer ou de désactiver.

otLinkMetricsQuery

otError otLinkMetricsQuery(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  const otLinkMetrics *aLinkMetricsFlags,
  otLinkMetricsReportCallback aCallback,
  void *aCallbackContext
)

Envoie une requête de données MLE pour interroger les métriques de lien.

Il peut s'agir d'une série à sonde unique ou à indicateur de suivi avant.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aSeriesId
ID de série sur lequel effectuer la requête, 0 pour une sonde unique.
[in] aLinkMetricsFlags
Pointeur vers des options spécifiant les métriques à interroger.
[in] aCallback
Pointeur vers une fonction appelée lors de la réception d'un rapport sur les métriques de lien.
[in] aCallbackContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Le message de requête concernant les métriques sur les liens a bien été envoyé.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer le message de requête de données MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination n'est pas de type liaison locale, ou le voisin est introuvable.
OT_ERROR_NOT_CAPABLE
Le voisin n'est pas un appareil Thread 1.2 et n'est pas compatible avec les métriques sur les liens.

otLinkMetricsSendLinkProbe

otError otLinkMetricsSendLinkProbe(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  uint8_t aSeriesId,
  uint8_t aLength
)

Envoie un message de vérification de lien MLE.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aSeriesId
ID de série [1, 254] visé par le message de vérification.
[in] aLength
Longueur de la charge utile de données dans Link Probe TLV, 0, 64.
Valeurs de retour
OT_ERROR_NONE
Le message de vérification des liens a bien été envoyé.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer le message de vérification de liaison MLE.
OT_ERROR_INVALID_ARGS
aSeriesId ou aLength n'est pas dans la plage valide.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination n'est pas de type liaison locale, ou le voisin est introuvable.
OT_ERROR_NOT_CAPABLE
Le voisin n'est pas un appareil Thread 1.2 et n'est pas compatible avec les métriques sur les liens.

Ressources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la section Ressources.