Métriques sur les liens

Ce module inclut des fonctions qui contrôlent le protocole de métriques relatives aux liens.

Résumé

Énumérations
otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
} 		enum
Indicateurs ACK améliorés.
otLinkMetricsStatus enum
Valeurs d'état des métriques de lien.

Typedefs
otLinkMetricsEnhAckFlags Typedef
Indicateurs ACK améliorés.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) Typedef
void(*
Ce pointeur de fonction est appelé lors de la réception d'Enh-ACK Probing IE.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, uint8_t aStatus, void *aContext) Typedef
void(*
Ce pointeur de fonction est appelé lorsqu'une réponse de gestion des métriques de lien est reçue.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, uint8_t aStatus, void *aContext) Typedef
void(*
Ce pointeur de fonction est appelé lorsqu'un rapport "Métriques de lien" est reçu.
otLinkMetricsSeriesFlags Typedef
Cette structure représente les trames qui sont comptabilisées dans une série de suivi des transferts.
otLinkMetricsStatus Typedef
Valeurs d'état des métriques de lien.
otLinkMetricsValues Typedef
Cette structure représente le résultat (valeur) d'une requête de statistiques de lien.

Functions
otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
Cette fonction envoie une requête de gestion des métriques de liaison MLE pour configurer/effacer une vérification basée sur l'accusé de réception amélioré.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Cette fonction envoie une requête de gestion des métriques de liaison MLE pour configurer/effacer une série de suivi des transferts.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
Cette fonction envoie une requête de données MLE pour interroger les métriques Link.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Cette fonction envoie un message de vérification du lien MLE.

Structure
otLinkMetricsSeriesFlags

Cette structure représente les trames qui sont comptabilisées dans une série de suivi des transferts.

otLinkMetricsValues

Cette structure représente le résultat (valeur) d'une requête de statistiques de lien.

Énumérations

otLinkMetricsEnhAckFlags

 otLinkMetricsEnhAckFlags

Indicateurs ACK améliorés.

Ces informations sont utilisées dans le cadre de la vérification basée sur le principe de détection avancée, pour indiquer si la vérification doit être enregistrée ou effacée.

Properties
OT_LINK_METRICS_ENH_ACK_CLEAR

OT_LINK_METRICS_ENH_ACK_REGISTER

Inscrivez-vous.

otLinkMetricsStatus

 otLinkMetricsStatus

Valeurs d'état des métriques de lien.

Typedefs

otLinkMetricsEnhAckFlags

enum otLinkMetricsEnhAckFlags otLinkMetricsEnhAckFlags

Indicateurs ACK améliorés.

Ces informations sont utilisées dans le cadre de la vérification basée sur le principe de détection avancée, 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)

Ce pointeur de fonction est appelé lors de la réception d'Enh-ACK Probing IE.

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

otLinkMetricsMgmtResponseCallback

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

Ce pointeur de fonction 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 le contexte spécifique à l'application

otLinkMetricsReportCallback

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

Ce pointeur de fonction est appelé lorsqu'un rapport "Métriques de lien" est reçu.

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

otLinkMetricsSeriesFlags

struct otLinkMetricsSeriesFlags otLinkMetricsSeriesFlags

Cette structure représente les trames qui sont comptabilisées dans une série de suivi des transferts.

otLinkMetricsStatus

enum otLinkMetricsStatus otLinkMetricsStatus

Valeurs d'état des métriques de lien.

otLinkMetricsValues

struct otLinkMetricsValues otLinkMetricsValues

Cette structure représente le résultat (valeur) d'une requête de statistiques de lien.

Functions

otLinkMetricsConfigEnhAckProbing

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

Cette fonction envoie une requête de gestion des métriques de liaison MLE pour configurer/effacer une vérification basée sur l'accusé de réception amélioré.

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

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aEnhAckFlags
Indicateurs Enh-ACK pour indiquer si la vérification doit être enregistrée ou effacée. 0 pour effacer et 1 pour s'inscrire. Les autres valeurs sont réservées.
[in] aLinkMetricsFlags
Pointeur vers les indicateurs spécifiant les métriques à interroger. La valeur doit être NULL lorsque aEnhAckFlags est 0.
[in] aCallback
Pointeur vers une fonction appelée lorsqu'un accusé de réception amélioré contenant des métriques de lien est reçu.
[in] aCallbackContext
Pointeur vers le contexte spécifique à l'application
Valeurs renvoyées
OT_ERROR_NONE
Le message "Demande de gestion des métriques de lien" 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 liaison MLE.
OT_ERROR_INVALID_ARGS
aEnhAckFlags n'est pas une valeur valide ou aLinkMetricsFlags n'est pas correct.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination n'est pas une liaison locale ou le voisin est introuvable.
OT_ERROR_NOT_CAPABLE
La voisine n'est pas un appareil Thread 1.2 et n'est pas compatible avec les métriques de lien.

otLinkMetricsConfigForwardTrackingSeries

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

Cette fonction envoie une requête de gestion des métriques de liaison MLE pour configurer/effacer une série de suivi des transferts.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aSeriesId
ID de série à utiliser avec
[in] aSeriesFlags
Indicateurs de la série qui spécifie les cadres à comptabiliser.
[in] aLinkMetricsFlags
Pointeur vers les indicateurs spécifiant les métriques à interroger. La valeur 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 le contexte spécifique à l'application
Valeurs renvoyées
OT_ERROR_NONE
Le message "Demande de gestion des métriques de lien" 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 liaison MLE.
OT_ERROR_INVALID_ARGS
La valeur de aSeriesId n'est pas valide.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination n'est pas une liaison locale ou le voisin est introuvable.
OT_ERROR_NOT_CAPABLE
La voisine n'est pas un appareil Thread 1.2 et n'est pas compatible avec les métriques de lien.

otLinkMetricsQuery

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

Cette fonction envoie une requête de données MLE pour interroger les métriques Link.

Il peut s'agir d'une vérification unique ou d'une série de suivi avant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aDestination
Pointeur vers l'adresse de destination.
[in] aSeriesId
Identifiant de série à interroger, 0 pour la vérification unique.
[in] aLinkMetricsFlags
Pointeur vers les indicateurs spécifiant les métriques à interroger.
[in] aCallback
Pointeur vers une fonction appelée à la réception du rapport "Métriques de lien".
[in] aCallbackContext
Pointeur vers le contexte spécifique à l'application
Valeurs renvoyées
OT_ERROR_NONE
Le message concernant la requête de métriques de lien a bien été envoyé.
OT_ERROR_NO_BUFS
Mémoire tampon insuffisante pour générer le message de requête de données MLE.
OT_ERROR_UNKNOWN_NEIGHBOR
aDestination n'est pas une liaison locale ou le voisin est introuvable.
OT_ERROR_NOT_CAPABLE
La voisine n'est pas un appareil Thread 1.2 et n'est pas compatible avec les métriques de lien.

otLinkMetricsSendLinkProbe.

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

Cette fonction envoie un message de vérification du lien MLE.

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

Resources

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 page Ressources.