History Tracker#

otHistoryTrackerAddressEvent#

otHistoryTrackerAddressEvent

This enumeration defines the events for an IPv6 (unicast or multicast) address info (i.e., whether address is added or removed).

@1#

@1

Constants representing message priority used in otHistoryTrackerMessageInfo struct.

otHistoryTrackerNeighborEvent#

otHistoryTrackerNeighborEvent

This enumeration defines the events in a neighbor info (i.e.

whether neighbor is added, removed, or changed).

Event OT_HISTORY_TRACKER_NEIGHBOR_EVENT_RESTORING is applicable to child neighbors only. It is triggered after the device (re)starts and when the previous children list is retrieved from non-volatile settings and the device tries to restore connection to them.

otHistoryTrackerRouterEvent#

otHistoryTrackerRouterEvent

This enumeration defines the events in a router info (i.e.

whether router is added, removed, or changed).

otHistoryTrackerNetDataEvent#

otHistoryTrackerNetDataEvent

This enumeration defines the events for a Network Data entry (i.e., whether an entry is added or removed).

otHistoryTrackerIterator#

typedef struct otHistoryTrackerIterator otHistoryTrackerIterator

This type represents an iterator to iterate through a history list.

The fields in this type are opaque (intended for use by OpenThread core) and therefore should not be accessed/used by caller.

Before using an iterator, it MUST be initialized using otHistoryTrackerInitIterator(),

otHistoryTrackerNetworkInfo#

typedef struct otHistoryTrackerNetworkInfo otHistoryTrackerNetworkInfo

This structure represents Thread network info.

otHistoryTrackerUnicastAddressInfo#

typedef struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo

This structure represent a unicast IPv6 address info.

otHistoryTrackerMulticastAddressInfo#

typedef struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo

This structure represent an IPv6 multicast address info.

otHistoryTrackerMessageInfo#

typedef struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

This structure represents a RX/TX IPv6 message info.

Some of the fields in this struct are applicable to a RX message or a TX message only, e.g., mAveRxRss is the average RSS of all fragment frames that form a received message and is only applicable for a RX message.

otHistoryTrackerNeighborInfo#

typedef struct otHistoryTrackerNeighborInfo otHistoryTrackerNeighborInfo

This structure represents a neighbor info.

otHistoryTrackerRouterInfo#

typedef struct otHistoryTrackerRouterInfo otHistoryTrackerRouterInfo

This structure represents a router table entry event.

otHistoryTrackerOnMeshPrefixInfo#

typedef struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo

This structure represent a Network Data on mesh prefix info.

otHistoryTrackerExternalRouteInfo#

typedef struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo

This structure represent a Network Data extern route info.

otHistoryTrackerInitIterator#

void otHistoryTrackerInitIterator (otHistoryTrackerIterator * aIterator)

This function initializes an otHistoryTrackerIterator.

An iterator MUST be initialized before it is used.

An iterator can be initialized again to start from the beginning of the list.

When iterating over entries in a list, to ensure the entry ages are consistent, the age is given relative to the time the iterator was initialized, i.e., the entry age is provided as the duration (in milliseconds) from the event (when entry was recorded) to the iterator initialization time.

otHistoryTrackerIterateNetInfoHistory#

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

This function iterates over the entries in the network info history list.

Returns

• A pointer to otHistoryTrackerNetworkInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateUnicastAddressHistory#

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

This function iterates over the entries in the unicast address history list.

Returns

• A pointer to otHistoryTrackerUnicastAddressInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateMulticastAddressHistory#

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

This function iterates over the entries in the multicast address history list.

Returns

• A pointer to otHistoryTrackerMulticastAddressInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateRxHistory#

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

This function iterates over the entries in the RX message history list.

Returns

• The otHistoryTrackerMessageInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateTxHistory#

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

This function iterates over the entries in the TX message history list.

Returns

• The otHistoryTrackerMessageInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateNeighborHistory#

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

This function iterates over the entries in the neighbor history list.

Returns

• The otHistoryTrackerNeighborInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateRouterHistory#

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

This function iterates over the entries in the router history list.

Returns

• The otHistoryTrackerRouterInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateOnMeshPrefixHistory#

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

This function iterates over the entries in the Network Data on mesh prefix entry history list.

Returns

• The otHistoryTrackerOnMeshPrefixInfo entry or NULL if no more entries in the list.

otHistoryTrackerIterateExternalRouteHistory#

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

This function iterates over the entries in the Network Data external route entry history list.

Returns

• The otHistoryTrackerExternalRouteInfo entry or NULL if no more entries in the list.

otHistoryTrackerEntryAgeToString#

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

This function converts a given entry age to a human-readable string.

The entry age string follows the format "<hh>:<mm>:<ss>.<mmmm>" for hours, minutes, seconds and millisecond (if shorter than one day) or "<dd> days <hh>:<mm>:<ss>.<mmmm>" (if longer than one day).

If the resulting string does not fit in aBuffer (within its aSize characters), the string will be truncated but the outputted string is always null-terminated.

OT_HISTORY_TRACKER_MAX_AGE#

#define OT_HISTORY_TRACKER_MAX_AGE

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

This constant specifies the maximum age of entries which is 49 days (in msec).

Entries older than the max age will give this value as their age.

OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE#

#define OT_HISTORY_TRACKER_ENTRY_AGE_STRING_SIZE

21

Recommended size for string representation of an entry age.

OT_HISTORY_TRACKER_NO_NEXT_HOP#

#define OT_HISTORY_TRACKER_NO_NEXT_HOP

63

No next hop - For mNextHop in otHistoryTrackerRouterInfo.

OT_HISTORY_TRACKER_INFINITE_PATH_COST#

#define OT_HISTORY_TRACKER_INFINITE_PATH_COST

0

Infinite path cost - used in otHistoryTrackerRouterInfo.