Suivi de l'historique

Enregistre l'historique de différents événements, par exemple les messages RX et TX ou les modifications apportées aux informations du réseau.

Résumé

Toutes les entrées suivies sont horodatées.

Les fonctions de ce module sont disponibles lorsque OPENTHREAD_CONFIG_HISTOR_TRACKER_ENABLE est activé.

Énumérations
anonymous enum{
  OT_HISTORY_TRACKER_MSG_PRIORITY_LOW = OT_MESSAGE_PRIORITY_LOW,
  OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL = OT_MESSAGE_PRIORITY_NORMAL,
  OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH = OT_MESSAGE_PRIORITY_HIGH,
  OT_HISTORY_TRACKER_MSG_PRIORITY_NET = OT_MESSAGE_PRIORITY_HIGH + 1
} 		enum
Constantes représentant la priorité des messages utilisés dans la structure otHistoryTrackerMessageInfo
otHistoryTrackerAddressEvent{
  OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED = 0,
  OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED = 1
} 		enum
Cette énumération définit les événements des informations d'adresse IPv6 (unicast ou multicast), c'est-à-dire si l'adresse est ajoutée ou supprimée.
otHistoryTrackerNeighborEvent{
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED = 0,
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED = 1,
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED = 2,
  OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING = 3
} 		enum
Cette énumération définit les événements dans les informations des voisins (par exemple,
otHistoryTrackerNetDataEvent{
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED = 0,
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED = 1
} 		enum
Cette énumération définit les événements pour une entrée de données réseau (par exemple, si une entrée est ajoutée ou supprimée).

Typedefs
otHistoryTrackerExternalRouteInfo Typedef
Cette structure représente les informations d'un itinéraire externe de données de réseau.
otHistoryTrackerIterator Typedef
Ce type représente un itérateur qui effectue une itération dans une liste d'historique.
otHistoryTrackerMessageInfo Typedef
Cette structure représente les informations d'un message IPv6 RX/TX.
otHistoryTrackerMulticastAddressInfo Typedef
Cette structure représente les informations d'adresse de multidiffusion IPv6.
otHistoryTrackerNeighborInfo Typedef
Cette structure représente les informations des voisins.
otHistoryTrackerNetworkInfo Typedef
Cette structure représente les informations concernant le réseau Thread.
otHistoryTrackerOnMeshPrefixInfo Typedef
Cette structure représente les données réseau sur le préfixe du réseau maillé.
otHistoryTrackerUnicastAddressInfo Typedef
Cette structure représente des informations d'adresse IPv6 unicast.

Functions
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
void
Cette fonction convertit l'âge d'une entrée donnée en une chaîne lisible.
otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
void
Cette fonction initialise un otHistoryTrackerIterator.
otHistoryTrackerIterateExternalRouteHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction parcourt les entrées de la liste de l'historique des entrées de la route réseau externe.
otHistoryTrackerIterateMulticastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction parcourt les entrées de la liste d'historique des adresses de multidiffusion.
otHistoryTrackerIterateNeighborHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction parcourt les entrées de la liste de l'historique voisine.
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction parcourt les entrées de la liste d'historique des informations réseau.
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction parcourt les entrées de la liste de l'historique des entrées du préfixe de données réseau sur le réseau maillé.
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction parcourt les entrées de la liste de l'historique des messages RX.
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction itère les entrées dans la liste de l'historique des messages TX.
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Cette fonction parcourt les entrées de la liste d'historique des adresses unicast.

Structure
otHistoryTrackerExternalRouteInfo

Cette structure représente les informations d'un itinéraire externe de données de réseau.

otHistoryTrackerIterator

Ce type représente un itérateur qui effectue une itération dans une liste d'historique.

otHistoryTrackerMessageInfo

Cette structure représente les informations d'un message IPv6 RX/TX.

otHistoryTrackerMulticastAddressInfo

Cette structure représente les informations d'adresse de multidiffusion IPv6.

otHistoryTrackerNeighborInfo

Cette structure représente les informations des voisins.

otHistoryTrackerNetworkInfo

Cette structure représente les informations concernant le réseau Thread.

otHistoryTrackerOnMeshPrefixInfo

Cette structure représente les données réseau sur le préfixe du réseau maillé.

otHistoryTrackerUnicastAddressInfo

Cette structure représente des informations d'adresse IPv6 unicast.

Énumérations

énumération anonyme

 anonymous enum

Constantes représentant la priorité des messages utilisés dans la structure otHistoryTrackerMessageInfo

Properties
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH

Niveau de priorité élevé.

OT_HISTORY_TRACKER_MSG_PRIORITY_LOW

Niveau de priorité faible.

OT_HISTORY_TRACKER_MSG_PRIORITY_NET

Priorité de contrôle du réseau.

OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL

Niveau de priorité normal.

otHistoryTrackerAddressEvent

 otHistoryTrackerAddressEvent

Cette énumération définit les événements des informations d'adresse IPv6 (unicast ou multicast), c'est-à-dire si l'adresse est ajoutée ou supprimée.

Properties
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED

L'adresse est ajoutée.

OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED

L'adresse est supprimée.

otHistoryTrackerNeighborEvent

 otHistoryTrackerNeighborEvent

Cette énumération définit les événements dans les informations des voisins (par exemple,

si le voisin est ajouté, supprimé ou modifié.

L'événement OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING ne s'applique qu'aux voisins enfants. Elle se déclenche une fois que l'appareil a redémarré et une fois que la liste des enfants enfants a été récupérée à partir de paramètres non volatils et que l'appareil tente de restaurer la connexion aux écrans enfants.

Properties
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED

Neighbor est ajouté.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED

Voisineur modifié (les options du mode de l'appareil ont été modifiées, par exemple).

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED

Voisin est supprimé.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING

Voisin en cours de restauration (applicable uniquement aux enfants)

otHistoryTrackerNetDataEvent

 otHistoryTrackerNetDataEvent

Cette énumération définit les événements pour une entrée de données réseau (par exemple, si une entrée est ajoutée ou supprimée).

Properties
OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED

L'entrée des données du réseau est ajoutée.

OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED

La saisie des données du réseau est supprimée.

Typedefs

otHistoryTrackerExternalRouteInfo

struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo

Cette structure représente les informations d'un itinéraire externe de données de réseau.

otHistoryTrackerIterator

struct otHistoryTrackerIterator otHistoryTrackerIterator

Ce type représente un itérateur qui effectue une itération dans une liste d'historique.

Les champs de ce type sont opaques (destinés à être utilisés par un cœur OpenThread) et ne doivent donc pas être accessibles/utilisés par l'appelant.

Avant d'utiliser un itérateur, il DOIT être initialisé à l'aide de otHistoryTrackerInitIterator().

otHistoryTrackerMessageInfo

struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

Cette structure représente les informations d'un message IPv6 RX/TX.

Certains champs de cette structure ne s'appliquent qu'à un message RX ou TX, par exemple, mAveRxRss correspond au RSS moyen de toutes les images fragmentées qui constituent un message reçu et ne s'applique qu'à un message RX.

otHistoryTrackerMulticastAddressInfo

struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo

Cette structure représente les informations d'adresse de multidiffusion IPv6.

otHistoryTrackerNeighborInfo

struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo

Cette structure représente les informations des voisins.

otHistoryTrackerNetworkInfo

struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo

Cette structure représente les informations concernant le réseau Thread.

otHistoryTrackerOnMeshPrefixInfo

struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo

Cette structure représente les données réseau sur le préfixe du réseau maillé.

otHistoryTrackerUnicastAddressInfo

struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo

Cette structure représente des informations d'adresse IPv6 unicast.

Functions

otHistoryTrackerEntryAgeToString

void otHistoryTrackerEntryAgeToString(
  uint32_t aEntryAge,
  char *aBuffer,
  uint16_t aSize
)

Cette fonction convertit l'âge d'une entrée donnée en une chaîne lisible.

La chaîne de l'âge d'entrée respecte le format "::(Installation de Python groupée)." pour les heures, les minutes, les secondes et les millisecondes (si moins d'un jour) ou "

jours ::." (pour les jours plus longs).

Si la chaîne obtenue ne tient pas dans aBuffer (dans ses aSize caractères), elle est tronquée, mais la chaîne générée est toujours associée à une valeur nulle.

Détails
Paramètres
[in] aEntryAge
agege de l'entrée (durée en ms).
[out] aBuffer
Pointeur vers un tableau de caractères pour générer la chaîne (NE DOIT PAS être NULL).
[in] aSize
Taille de aBuffer. Utilisation recommandée : OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE.

otHistoryTrackerInitIterator

void otHistoryTrackerInitIterator(
  otHistoryTrackerIterator *aIterator
)

Cette fonction initialise un otHistoryTrackerIterator.

Un itérateur DOIT s'initialiser avant de pouvoir être utilisé.

Un itérateur peut être initialisé à nouveau pour commencer à partir du début de la liste.

Lors de l'itération sur les entrées d'une liste, afin de garantir la cohérence des âges des entrées, l'âge est indiqué par rapport à l'heure d'initialisation de l'itérateur, c'est-à-dire que l'âge d'entrée est fourni en tant que durée (en millisecondes) à partir de l'événement (lorsque l'entrée était enregistrée) au moment de l'initialisation de l'itérateur.

Détails
Paramètres
[in] aIterator
Pointeur vers l'itérateur à initialiser (NE DOIT PAS être NULL).

otHistoryTrackerIterateExternalRouteHistory

const otHistoryTrackerExternalRouteInfo * otHistoryTrackerIterateExternalRouteHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction parcourt les entrées de la liste de l'historique des entrées de la route réseau externe.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
L'entrée otHistoryTrackerExternalRouteInfo ou NULL si la liste ne contient plus d'entrées.

otHistoryTrackerIterateMulticastAddressHistory

const otHistoryTrackerMulticastAddressInfo * otHistoryTrackerIterateMulticastAddressHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction parcourt les entrées de la liste d'historique des adresses de multidiffusion.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
Pointeur vers l'entrée otHistoryTrackerMulticastAddressInfo ou NULL si la liste ne contient plus d'entrées

otHistoryTrackerIterateNeighborHistory

const otHistoryTrackerNeighborInfo * otHistoryTrackerIterateNeighborHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction parcourt les entrées de la liste de l'historique voisine.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
L'entrée otHistoryTrackerNeighborInfo ou NULL si la liste ne contient plus d'entrées.

otHistoryTrackerIterateNetInfoHistory

const otHistoryTrackerNetworkInfo * otHistoryTrackerIterateNetInfoHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction parcourt les entrées de la liste d'historique des informations réseau.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
Pointeur vers l'entrée otHistoryTrackerNetworkInfo ou NULL si la liste ne contient plus d'entrées

otHistoryTrackerIterateOnMeshPrefixHistory

const otHistoryTrackerOnMeshPrefixInfo * otHistoryTrackerIterateOnMeshPrefixHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction parcourt les entrées de la liste de l'historique des entrées du préfixe de données réseau sur le réseau maillé.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
L'entrée otHistoryTrackerOnMeshPrefixInfo ou NULL si la liste ne contient plus d'entrées.

otHistoryTrackerIterateRxHistory

const otHistoryTrackerMessageInfo * otHistoryTrackerIterateRxHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction parcourt les entrées de la liste de l'historique des messages RX.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
L'entrée otHistoryTrackerMessageInfo ou NULL si la liste ne contient plus d'entrées.

otHistoryTrackerIterateTxHistory

const otHistoryTrackerMessageInfo * otHistoryTrackerIterateTxHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction itère les entrées dans la liste de l'historique des messages TX.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
L'entrée otHistoryTrackerMessageInfo ou NULL si la liste ne contient plus d'entrées.

otHistoryTrackerIterateUnicastAddressHistory

const otHistoryTrackerUnicastAddressInfo * otHistoryTrackerIterateUnicastAddressHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Cette fonction parcourt les entrées de la liste d'historique des adresses unicast.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT s'initialiser ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable permettant d'afficher l'âge de l'entrée. ne DOIT PAS être NULL. L'âge est indiqué comme durée (en millisecondes) à partir de la date d'enregistrement de l'entrée dans le délai d'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à la limite d'âge.
Renvoie
Pointeur vers l'entrée otHistoryTrackerUnicastAddressInfo ou NULL si la liste ne contient plus d'entrées

Macros

OT_History_TRACKER_ENTRY_AGE_STRING_SIZE

 OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21

Taille recommandée pour la représentation sous forme de chaîne d'une ancienneté d'entrée.

OT_HISTORIQUE_TRACKER_MAX_AGE

 OT_HISTORY_TRACKER_MAX_AGE (49 * 24 * 60 * 60 * 1000u)

Cette constante spécifie l'ancienneté maximale des entrées (49 jours).

Les entrées antérieures à l'âge maximal indiquent la valeur correspondante.

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.