Outil de suivi de l'historique

Enregistre l'historique de différents événements, tels que les messages RX et TX ou les modifications des informations sur le réseau.

Résumé

Toutes les entrées suivies sont horodatées.

Les fonctions de ce module sont disponibles lorsque OPENTHREAD_CONFIG_HISTORY_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ées dans la struct otHistoryTrackerMessageInfo
otHistoryTrackerAddressEvent{
  OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED = 0,
  OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED = 1
} 		enum
Définit les événements pour une adresse IPv6 (monidiffusion ou multidiffusion) (c'est-à-dire si une 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
Définit les événements dans des informations voisines (par exemple,
otHistoryTrackerNetDataEvent{
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED = 0,
  OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED = 1
} 		enum
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).
otHistoryTrackerRouterEvent{
  OT_HISTORY_TRACKER_ROUTER_EVENT_ADDED = 0,
  OT_HISTORY_TRACKER_ROUTER_EVENT_REMOVED = 1,
  OT_HISTORY_TRACKER_ROUTER_EVENT_NEXT_HOP_CHANGED = 2,
  OT_HISTORY_TRACKER_ROUTER_EVENT_COST_CHANGED = 3
} 		enum
Définit les événements dans les informations d'un routeur (par exemple,

Typedefs
otHistoryTrackerExternalRouteInfo typedef
Représenter une info sur l'itinéraire externe de données réseau.
otHistoryTrackerIterator typedef
Représente un itérateur pour effectuer une itération sur une liste d'historique.
otHistoryTrackerMessageInfo typedef
Représente les informations d'un message IPv6 RX/TX.
otHistoryTrackerMulticastAddressInfo typedef
Représente les informations d'une adresse de multidiffusion IPv6.
otHistoryTrackerNeighborInfo typedef
Représente des informations sur un voisin.
otHistoryTrackerNetworkInfo typedef
Représente les informations sur le réseau Thread.
otHistoryTrackerOnMeshPrefixInfo typedef
Représente des données réseau sur les informations liées au préfixe du réseau maillé.
otHistoryTrackerRouterInfo typedef
Représente un événement d'entrée de table de routeur.
otHistoryTrackerUnicastAddressInfo typedef
Représente les informations d'une adresse IPv6 en monodiffusion.

distantes
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
void
Convertit un âge d'entrée donné en une chaîne lisible.
otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
void
Initialise un otHistoryTrackerIterator.
otHistoryTrackerIterateExternalRouteHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itère les entrées de la liste de l'historique des entrées de routage externe des données réseau.
otHistoryTrackerIterateMulticastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itération des entrées de l'historique des adresses de multidiffusion.
otHistoryTrackerIterateNeighborHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itérez les entrées de la liste d'historique des voisins.
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itérez les entrées de l'historique des informations sur le réseau.
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itérez les entrées de la liste d'historique des entrées des données réseau sur le préfixe du réseau maillé.
otHistoryTrackerIterateRouterHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itère les entrées de la liste d'historique des routeurs.
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Il itère les entrées de l'historique des messages RX.
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itération des entrées de l'historique des messages TX.
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
Itération des entrées de la liste d'historique des adresses en monodiffusion.

Structs
otHistoryTrackerExternalRouteInfo

Représenter une info sur l'itinéraire externe de données réseau.

otHistoryTrackerIterator

Représente un itérateur pour effectuer une itération sur une liste d'historique.

otHistoryTrackerMessageInfo

Représente les informations d'un message IPv6 RX/TX.

otHistoryTrackerMulticastAddressInfo

Représente les informations d'une adresse de multidiffusion IPv6.

otHistoryTrackerNeighborInfo

Représente des informations sur un voisin.

otHistoryTrackerNetworkInfo

Représente les informations sur le réseau Thread.

otHistoryTrackerOnMeshPrefixInfo

Représente des données réseau sur les informations liées au préfixe du réseau maillé.

otHistoryTrackerRouterInfo

Représente un événement d'entrée de table de routeur.

otHistoryTrackerUnicastAddressInfo

Représente les informations d'une adresse IPv6 en monodiffusion.

Énumérations

énumération anonyme

 anonymous enum

Constantes représentant la priorité des messages utilisées dans la struct otHistoryTrackerMessageInfo

Propriétés
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

Niveau de priorité du contrôle du réseau.

OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL

Niveau de priorité normal.

otHistoryTrackerAddressEvent

 otHistoryTrackerAddressEvent

Définit les événements pour une adresse IPv6 (monidiffusion ou multidiffusion) (c'est-à-dire si une adresse est ajoutée ou supprimée).

Propriétés
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED

L'adresse a été ajoutée.

OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED

L'adresse est supprimée.

otHistoryTrackerNeighborEvent

 otHistoryTrackerNeighborEvent

Définit les événements dans des informations voisines (par exemple,

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

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

Propriétés
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED

Le voisin a été ajouté.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED

Voisin modifié (par exemple, indicateurs de mode de l'appareil modifiés).

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED

Le voisin a été supprimé.

OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING

Le voisin est en cours de restauration (applicable uniquement aux enfants).

otHistoryTrackerNetDataEvent

 otHistoryTrackerNetDataEvent

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).

Propriétés
OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED

Une entrée de données réseau a été ajoutée.

OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED

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

otHistoryTrackerRouterEvent

 otHistoryTrackerRouterEvent

Définit les événements dans les informations d'un routeur (par exemple,

si un routeur est ajouté, supprimé ou modifié).

Propriétés
OT_HISTORY_TRACKER_ROUTER_EVENT_ADDED

Le routeur est ajouté (l'ID de routeur est alloué).

OT_HISTORY_TRACKER_ROUTER_EVENT_COST_CHANGED

Le coût du chemin d'entrée du routeur a été modifié (saut suivant comme précédemment).

OT_HISTORY_TRACKER_ROUTER_EVENT_NEXT_HOP_CHANGED

Le saut suivant de l'entrée du routeur et le coût ont été modifiés.

OT_HISTORY_TRACKER_ROUTER_EVENT_REMOVED

L'entrée de routeur est supprimée (l'ID de routeur est libéré).

Typedefs

otHistoryTrackerExternalRouteInfo

struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo

Représenter une info sur l'itinéraire externe de données réseau.

otHistoryTrackerIterator

struct otHistoryTrackerIterator otHistoryTrackerIterator

Représente un itérateur pour effectuer une itération sur une liste d'historique.

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

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

otHistoryTrackerMessageInfo

struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

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 est le RSS moyen de tous les trames de fragment qui forment un message reçu et ne s'applique qu'à un message RX.

otHistoryTrackerMulticastAddressInfo

struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo

Représente les informations d'une adresse de multidiffusion IPv6.

otHistoryTrackerNeighborInfo

struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo

Représente des informations sur un voisin.

otHistoryTrackerNetworkInfo

struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo

Représente les informations sur le réseau Thread.

otHistoryTrackerOnMeshPrefixInfo

struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo

Représente des données réseau sur les informations liées au préfixe du réseau maillé.

otHistoryTrackerRouterInfo

struct otHistoryTrackerRouterInfo otHistoryTrackerRouterInfo

Représente un événement d'entrée de table de routeur.

otHistoryTrackerUnicastAddressInfo

struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo

Représente les informations d'une adresse IPv6 en monodiffusion.

distantes

otHistoryTrackerEntryAgeToString

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

Convertit un âge d'entrée donné en une chaîne lisible.

La chaîne d'âge de l'entrée suit le format "::." pour les heures, les minutes, les secondes et les millisecondes (si elle est inférieure à un jour) ou "

jours ::." (si elle dure plus d'une journée).

Si la chaîne obtenue ne rentre pas dans aBuffer (de ses caractères aSize), elle sera tronquée, mais la sortie sera toujours nulle et se termine toujours.

Détails
Paramètres
[in] aEntryAge
Âge de l'entrée (durée en ms).
[out] aBuffer
Un 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 de OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE.

otHistoryTrackerInitIterator

void otHistoryTrackerInitIterator(
  otHistoryTrackerIterator *aIterator
)

Initialise un otHistoryTrackerIterator.

Un itérateur DOIT être initialisé avant d'être utilisé.

Un itérateur peut être initialisé à nouveau pour recommencer depuis le début de la liste.

Lors de l'itération des entrées d'une liste, pour garantir la cohérence des âges des entrées, l'âge est indiqué en fonction de l'heure d'initialisation de l'itérateur, c'est-à-dire la durée (en millisecondes) écoulée entre l'événement (enregistrement de l'entrée) et l'heure d'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
)

Itère les entrées de la liste de l'historique des entrées de routage externe des données réseau.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
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
)

Itération des entrées de l'historique des adresses de multidiffusion.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
Renvoie
Un 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
)

Itérez les entrées de la liste d'historique des voisins.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
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
)

Itérez les entrées de l'historique des informations sur le réseau.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
Renvoie
Un 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
)

Itérez les entrées de la liste d'historique des entrées des données réseau sur le préfixe du réseau maillé.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
Renvoie
L'entrée otHistoryTrackerOnMeshPrefixInfo ou NULL si la liste ne contient plus d'entrées.

otHistoryTrackerIterateRouterHistory

const otHistoryTrackerRouterInfo * otHistoryTrackerIterateRouterHistory(
  otInstance *aInstance,
  otHistoryTrackerIterator *aIterator,
  uint32_t *aEntryAge
)

Itère les entrées de la liste d'historique des routeurs.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
Renvoie
L'entrée otHistoryTrackerRouterInfo ou NULL si la liste ne contient plus d'entrées.

otHistoryTrackerIterateRxHistory

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

Il itère les entrées de l'historique des messages RX.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
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
)

Itération des entrées de l'historique des messages TX.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
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
)

Itération des entrées de la liste d'historique des adresses en monodiffusion.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in,out] aIterator
Pointeur vers un itérateur. DOIT être initialisé, ou le comportement n'est pas défini.
[out] aEntryAge
Pointeur vers une variable pour afficher l'âge de l'entrée. NE DOIT PAS être NULL. L'âge est indiqué sous la forme de la durée (en millisecondes) écoulée entre l'enregistrement de l'entrée et l'initialisation de aIterator. Il est défini sur OT_HISTORY_TRACKER_MAX_AGE pour les entrées antérieures à l'âge maximal.
Renvoie
Un 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 représenter sous forme de chaîne l'âge d'une entrée.

OT_HISTORY_TRACKER_INFINITE_PATH_COST

 OT_HISTORY_TRACKER_INFINITE_PATH_COST 0

Coût du chemin infini – utilisé dans otHistoryTrackerRouterInfo.

OT_HISTORY_TRACKER_MAX_AGE

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

Cette constante spécifie l'âge maximal des entrées, qui est de 49 jours (en millisecondes).

Les entrées dont l'âge est supérieur à l'âge maximal seront associées à cette valeur.

OT_HISTORY_TRACKER_NO_NEXT_HOP

 OT_HISTORY_TRACKER_NO_NEXT_HOP 63

Aucun saut suivant : pour mNextHop dans otHistoryTrackerRouterInfo.

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.