Seguimiento de historial
Registra el historial de diferentes eventos, como mensajes de recepción y transmisión, o cambios de información de red.
Resumen
Todas las entradas con seguimiento tienen una marca de tiempo.
Las funciones de este módulo están disponibles cuando se habilita OPENTHREAD_CONFIG_HISTOR_TRACKER_ENABLE
.
Enumeraciones |
|
---|---|
anonymous enum{
|
enum Constantes que representan la prioridad de los mensajes que se usan en la estructura de otHistoryTrackerMessageInfo . |
otHistoryTrackerAddressEvent{
|
enum En esta enumeración se definen los eventos para una información de dirección IPv6 (unidifusión o multidifusión) (es decir, si la dirección se agrega o se quita). |
otHistoryTrackerNeighborEvent{
|
enum Esta enumeración define los eventos en una información vecina (es decir, |
otHistoryTrackerNetDataEvent{
|
enum Esta enumeración define los eventos para una entrada de datos de red (es decir, si una entrada se agrega o se quita). |
Typedefs |
|
---|---|
otHistoryTrackerExternalRouteInfo
|
typedef Esta estructura representa una información de ruta externa de datos de red. |
otHistoryTrackerIterator
|
typedefstruct otHistoryTrackerIterator
Este tipo representa un iterador para iterar a través de una lista del historial. |
otHistoryTrackerMessageInfo
|
typedefstruct otHistoryTrackerMessageInfo
Esta estructura representa una información de mensaje IPv6 de RX/TX. |
otHistoryTrackerMulticastAddressInfo
|
typedef Esta estructura representa información de dirección multidifusión IPv6. |
otHistoryTrackerNeighborInfo
|
typedefstruct otHistoryTrackerNeighborInfo
Esta estructura representa información de un vecino. |
otHistoryTrackerNetworkInfo
|
typedefstruct otHistoryTrackerNetworkInfo
Esta estructura representa información de la red de Thread. |
otHistoryTrackerOnMeshPrefixInfo
|
typedef Esta estructura representa una información de red en prefijo de malla. |
otHistoryTrackerUnicastAddressInfo
|
typedef Esta estructura representa una información de dirección IPv6 de unidifusión. |
Funciones |
|
---|---|
otHistoryTrackerEntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize)
|
void
Esta función convierte una antigüedad de entrada determinada en una string legible.
|
otHistoryTrackerInitIterator(otHistoryTrackerIterator *aIterator)
|
void
Esta función inicializa un elemento
otHistoryTrackerIterator . |
otHistoryTrackerIterateExternalRouteHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Esta función itera en las entradas de la lista de historial de entradas de rutas externas de datos de red.
|
otHistoryTrackerIterateMulticastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Esta función itera en las entradas de la lista del historial de direcciones multidifusión.
|
otHistoryTrackerIterateNeighborHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerNeighborInfo *
Esta función itera en las entradas de la lista del historial de vecino.
|
otHistoryTrackerIterateNetInfoHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerNetworkInfo *
Esta función itera en las entradas de la lista del historial de información de la red.
|
otHistoryTrackerIterateOnMeshPrefixHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerOnMeshPrefixInfo *
Esta función itera en las entradas de la lista de historial de entradas del prefijo de malla de datos de red.
|
otHistoryTrackerIterateRxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
Esta función itera en las entradas de la lista del historial de mensajes de RX.
|
otHistoryTrackerIterateTxHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
const otHistoryTrackerMessageInfo *
Esta función itera en las entradas de la lista del historial de mensajes TX.
|
otHistoryTrackerIterateUnicastAddressHistory(otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge)
|
Esta función itera en las entradas de la lista del historial de direcciones de unidifusión.
|
Structs |
|
---|---|
otHistoryTrackerExternalRouteInfo (en inglés) |
Esta estructura representa una información de ruta externa de datos de red. |
otHistoryTrackerIterator |
Este tipo representa un iterador para iterar a través de una lista del historial. |
otHistoryTrackerMessageInfo |
Esta estructura representa una información de mensaje IPv6 de RX/TX. |
otHistoryTrackerMulticastAddressInfo |
Esta estructura representa información de dirección multidifusión IPv6. |
otHistoryTrackerNeighborInfo |
Esta estructura representa información de un vecino. |
otHistoryTrackerNetworkInfo |
Esta estructura representa información de la red de Thread. |
otHistoryTrackerOnMeshPrefixInfo |
Esta estructura representa una información de red en prefijo de malla. |
otHistoryTrackerUnicastAddressInfo |
Esta estructura representa una información de dirección IPv6 de unidifusión. |
Enumeraciones
enumeración anónima
anonymous enum
Constantes que representan la prioridad de los mensajes que se usan en la estructura de otHistoryTrackerMessageInfo
.
Propiedades | |
---|---|
OT_HISTORY_TRACKER_MSG_PRIORITY_HIGH
|
Nivel de prioridad alta. |
OT_HISTORY_TRACKER_MSG_PRIORITY_LOW
|
Nivel de prioridad bajo. |
OT_HISTORY_TRACKER_MSG_PRIORITY_NET
|
Nivel de prioridad de control de red. |
OT_HISTORY_TRACKER_MSG_PRIORITY_NORMAL
|
Nivel de prioridad normal. |
otHistoryTrackerAddressEvent
otHistoryTrackerAddressEvent
En esta enumeración se definen los eventos para una información de dirección IPv6 (unidifusión o multidifusión) (es decir, si la dirección se agrega o se quita).
Propiedades | |
---|---|
OT_HISTORY_TRACKER_ADDRESS_EVENT_ADDED
|
Se agrega la dirección. |
OT_HISTORY_TRACKER_ADDRESS_EVENT_REMOVED
|
Se quitó la dirección. |
otHistoryTrackerNeighborEvent
otHistoryTrackerNeighborEvent
Esta enumeración define los eventos en una información vecina (es decir,
si se agrega, quita o cambia el vecino.
El evento OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING
solo se aplica a vecinos secundarios. Se activa después de que el dispositivo se vuelve a iniciar y cuando la lista secundaria anterior se recupera de configuraciones no volátiles y el dispositivo intenta restablecer la conexión con ellas.
Propiedades | |
---|---|
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_ADDED
|
Se agregó el vecindario. |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_CHANGED
|
Se cambió el vecindario (p.ej., se cambiaron las marcas del modo de dispositivo). |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_REMOVED
|
Se quitó el vecino. |
OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING
|
Se está restableciendo el vecindario (solo se aplica a niños). |
otHistoryTrackerNetDataEvent
otHistoryTrackerNetDataEvent
Esta enumeración define los eventos para una entrada de datos de red (es decir, si una entrada se agrega o se quita).
Propiedades | |
---|---|
OT_HISTORY_TRACKER_NET_DATA_ENTRY_ADDED
|
Se agregó la entrada de datos de red. |
OT_HISTORY_TRACKER_NET_DATA_ENTRY_REMOVED
|
Se quita la entrada de datos de red. |
Typedefs
otHistoryTrackerExternalRouteInfo
struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo
Esta estructura representa una información de ruta externa de datos de red.
otHistoryTrackerIterator
struct otHistoryTrackerIterator otHistoryTrackerIterator
Este tipo representa un iterador para iterar a través de una lista del historial.
Los campos de este tipo son opacos (previsto para el uso del núcleo de OpenThread) y, por lo tanto, el emisor no debe acceder a ellos ni utilizarlos.
Antes de usar un iterador, DEBE inicializarse con otHistoryTrackerInitIterator()
.
otHistoryTrackerMessageInfo
struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo
Esta estructura representa una información de mensaje IPv6 de RX/TX.
Algunos de los campos de esta estructura se aplican solo a un mensaje RX o TX, p.ej., mAveRxRss
es el RSS promedio de todos los marcos de fragmentos que forman un mensaje recibido y solo se aplica a un mensaje RX.
otHistoryTrackerMulticastAddressInfo
struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo
Esta estructura representa información de dirección multidifusión IPv6.
otHistoryTrackerNeighborInfo
struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo
Esta estructura representa información de un vecino.
otHistoryTrackerNetworkInfo
struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo
Esta estructura representa información de la red de Thread.
OtHistoryTrackerOnMeshPrefixInfo
struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo
Esta estructura representa una información de red en prefijo de malla.
otHistoryTrackerUnicastAddressInfo
struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo
Esta estructura representa una información de dirección IPv6 de unidifusión.
Funciones
otHistoryTrackerEntryAgeToString
void otHistoryTrackerEntryAgeToString( uint32_t aEntryAge, char *aBuffer, uint16_t aSize )
Esta función convierte una antigüedad de entrada determinada en una string legible.
La string de antigüedad de la entrada sigue el formato &
Si la string resultante no cabe en aBuffer
(dentro de sus caracteres aSize
), la string se truncará, pero la string resultante siempre será nula.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otHistoryTrackerInitIterator
void otHistoryTrackerInitIterator( otHistoryTrackerIterator *aIterator )
Esta función inicializa un elemento otHistoryTrackerIterator
.
Se debe inicializar un iterador antes de usarlo.
Se puede inicializar un iterador nuevamente para comenzar desde el principio de la lista.
Cuando se realizan iteraciones sobre las entradas de una lista, para garantizar que las edades de entrada sean coherentes, la edad se proporciona en relación con el momento en que se inicializó el iterador, es decir, la duración de la entrada se muestra como la duración (en milisegundos) desde el evento (cuando se registró la entrada) hasta el tiempo de inicialización del iterador.
Detalles | |||
---|---|---|---|
Parámetros |
|
OtHistoryTrackerIterateExternalRouteHistory
const otHistoryTrackerExternalRouteInfo * otHistoryTrackerIterateExternalRouteHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista de historial de entradas de rutas externas de datos de red.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
La entrada
otHistoryTrackerExternalRouteInfo o NULL si no hay más entradas en la lista |
otHistoryTrackerIterateMulticastAddressHistory
const otHistoryTrackerMulticastAddressInfo * otHistoryTrackerIterateMulticastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista del historial de direcciones multidifusión.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
Un puntero para la entrada
otHistoryTrackerMulticastAddressInfo o NULL si no hay más entradas en la lista. |
OtHistoryTrackerIterateNeighborHistory
const otHistoryTrackerNeighborInfo * otHistoryTrackerIterateNeighborHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista del historial de vecino.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
La entrada
otHistoryTrackerNeighborInfo o NULL si no hay más entradas en la lista |
OtHistoryTrackerIterateNetInfoHistory
const otHistoryTrackerNetworkInfo * otHistoryTrackerIterateNetInfoHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista del historial de información de la red.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
Un puntero para la entrada
otHistoryTrackerNetworkInfo o NULL si no hay más entradas en la lista. |
OtHistoryTrackerIterateOnMeshPrefixHistory
const otHistoryTrackerOnMeshPrefixInfo * otHistoryTrackerIterateOnMeshPrefixHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista de historial de entradas del prefijo de malla de datos de red.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
La entrada
otHistoryTrackerOnMeshPrefixInfo o NULL si no hay más entradas en la lista |
OtHistoryTrackerIterateRxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateRxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista del historial de mensajes de RX.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
La entrada
otHistoryTrackerMessageInfo o NULL si no hay más entradas en la lista |
OtHistoryTrackerIterateTxHistory
const otHistoryTrackerMessageInfo * otHistoryTrackerIterateTxHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista del historial de mensajes TX.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
La entrada
otHistoryTrackerMessageInfo o NULL si no hay más entradas en la lista |
otHistoryTrackerIterateUnicastAddressHistory
const otHistoryTrackerUnicastAddressInfo * otHistoryTrackerIterateUnicastAddressHistory( otInstance *aInstance, otHistoryTrackerIterator *aIterator, uint32_t *aEntryAge )
Esta función itera en las entradas de la lista del historial de direcciones de unidifusión.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Qué muestra |
Un puntero para la entrada
otHistoryTrackerUnicastAddressInfo o NULL si no hay más entradas en la lista. |
Macros
OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE
OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE 21
Tamaño recomendado para la representación de strings de una antigüedad de entrada.
OT_HISTORY_TRACKER_MAX_AGE
OT_HISTORY_TRACKER_MAX_AGE (49 * 24 * 60 * 60 * 1000u)
Esta constante especifica la antigüedad máxima de las entradas, que es de 49 días (en ms).
Las entradas con una antigüedad superior a la edad máxima asignarán este valor a la antigüedad.
Recursos
Los temas de referencia de la API de OpenThread se originan en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.