History Tracker#

otHistoryTrackerAddressEvent#

otHistoryTrackerAddressEvent

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

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

Defines the events in a router info (i.e.

whether router is added, removed, or changed).

otHistoryTrackerNetDataEvent#

otHistoryTrackerNetDataEvent

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

otHistoryTrackerDnsSrpAddrType#

otHistoryTrackerDnsSrpAddrType

Represents the DNS/SRP server address type parsed from Network Data service entries.

otHistoryTrackerBorderAgentEpskcEvent#

otHistoryTrackerBorderAgentEpskcEvent

Represents events during the Border Agent's ePSKc journey.

otHistoryTrackerAilRouterEvent#

otHistoryTrackerAilRouterEvent

Defines events for discovered routers on an Adjacent Infrastructure Link (AIL).

This applies when a device is acting as a Border Router, processing received Router Advertisements and tracking AIL routers.

OT_HISTORY_TRACKER_AIL_ROUTER_EVENT_CHANGED is used if any of the properties in the otHistoryTrackerAilRouter structure associated with a specific router changes.

otHistoryTrackerIterator#

typedef struct otHistoryTrackerIterator otHistoryTrackerIterator

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

Represents Thread network info.

otHistoryTrackerUnicastAddressInfo#

typedef struct otHistoryTrackerUnicastAddressInfo otHistoryTrackerUnicastAddressInfo

Represent a unicast IPv6 address info.

otHistoryTrackerMulticastAddressInfo#

typedef struct otHistoryTrackerMulticastAddressInfo otHistoryTrackerMulticastAddressInfo

Represent an IPv6 multicast address info.

otHistoryTrackerMessageInfo#

typedef struct otHistoryTrackerMessageInfo otHistoryTrackerMessageInfo

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

Represents a neighbor info.

otHistoryTrackerRouterInfo#

typedef struct otHistoryTrackerRouterInfo otHistoryTrackerRouterInfo

Represents a router table entry event.

otHistoryTrackerOnMeshPrefixInfo#

typedef struct otHistoryTrackerOnMeshPrefixInfo otHistoryTrackerOnMeshPrefixInfo

Represent a Network Data on mesh prefix info.

otHistoryTrackerExternalRouteInfo#

typedef struct otHistoryTrackerExternalRouteInfo otHistoryTrackerExternalRouteInfo

Represent a Network Data extern route info.

otHistoryTrackerDnsSrpAddrInfo#

typedef struct otHistoryTrackerDnsSrpAddrInfo otHistoryTrackerDnsSrpAddrInfo

Represents DNS/SRP server address information parsed from a Network Data service entry.

The mType field specifies the entry type. Some fields are only applicable to specific types.

• The mPort field is only applicable for OT_HISTORY_TRACKER_DNS_SRP_ADDR_TYPE_UNICAST_* types.

• The mSequenceNumber field is only applicable for the OT_HISTORY_TRACKER_DNS_SRP_ADDR_TYPE_ANYCAST type.

• Other fields are common and used for all address types.

otHistoryTrackerFavoredOmrPrefix#

typedef struct otHistoryTrackerFavoredOmrPrefix otHistoryTrackerFavoredOmrPrefix

Represents a favored OMR prefix tracked by a device acting as a Border Router (BR).

The mIsLocal field indicates whether the favored OMR prefix is the same as the local one maintained by this BR. The local OMR prefix can be either based on (random) ULA or a prefix delegated via DHCPv6-PD.

otHistoryTrackerFavoredOnLinkPrefix#

typedef struct otHistoryTrackerFavoredOnLinkPrefix otHistoryTrackerFavoredOnLinkPrefix

Represents a favored on-link prefix on AIL tracked by a device acting as a Border Router (BR).

The mIsLocal field indicates whether the favored on-link prefix is the same as the local one maintained by this BR.

otHistoryTrackerDhcp6PdInfo#

typedef struct otHistoryTrackerDhcp6PdInfo otHistoryTrackerDhcp6PdInfo

Represents the DHCPv6-PD state and delegated prefix (if any) by a device acting as Border Router (BR).

otHistoryTrackerAilRouter#

typedef struct otHistoryTrackerAilRouter otHistoryTrackerAilRouter

Represents information about a discovered router on an Adjacent Infrastructure Link (AIL).

This applies when a device is acting as a Border Router, processing received Router Advertisements and tracking information about discovered AIL routers.

mProvidesDefaultRoute indicates whether the router provides a default route. If it does, mDefRoutePreference specifies the route preference.

mFavoredOnLinkPrefix indicates the favored on-link prefix advertised by the router. If there is no on-link prefix, this will be an empty prefix (i.e., its length will be zero).

otHistoryTrackerInitIterator#

void otHistoryTrackerInitIterator (otHistoryTrackerIterator * aIterator)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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.

otHistoryTrackerIterateDnsSrpAddrHistory#

const otHistoryTrackerDnsSrpAddrInfo * otHistoryTrackerIterateDnsSrpAddrHistory (otInstance * aInstance, otHistoryTrackerIterator * aIterator, uint32_t * aEntryAge)

Iterates over the entries in the Network Data SRP/DNS address history list.

Returns

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

otHistoryTrackerIterateBorderAgentEpskcEventHistory#

const otHistoryTrackerBorderAgentEpskcEvent * otHistoryTrackerIterateBorderAgentEpskcEventHistory (otInstance * aInstance, otHistoryTrackerIterator * aIterator, uint32_t * aEntryAge)

Iterates over the entries in the Border Agent ePSKc history list.

Returns

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

otHistoryTrackerIterateFavoredOmrPrefixHistory#

const otHistoryTrackerFavoredOmrPrefix * otHistoryTrackerIterateFavoredOmrPrefixHistory (otInstance * aInstance, otHistoryTrackerIterator * aIterator, uint32_t * aEntryAge)

Iterates over the entries in the favored OMR prefix history list.

Requires OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE (device acting as Border Router).

Returns

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

otHistoryTrackerIterateFavoredOnLinkPrefixHistory#

const otHistoryTrackerFavoredOnLinkPrefix * otHistoryTrackerIterateFavoredOnLinkPrefixHistory (otInstance * aInstance, otHistoryTrackerIterator * aIterator, uint32_t * aEntryAge)

Iterates over the entries in the favored on-link prefix history list.

Requires OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE (device acting as Border Router).

Returns

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

otHistoryTrackerIterateDhcp6PdHistory#

const otHistoryTrackerDhcp6PdInfo * otHistoryTrackerIterateDhcp6PdHistory (otInstance * aInstance, otHistoryTrackerIterator * aIterator, uint32_t * aEntryAge)

Iterates over the entries in the DHCPv6-PD history list.

Requires both OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE and OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE.

Returns

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

otHistoryTrackerIterateAilRoutersHistory#

const otHistoryTrackerAilRouter * otHistoryTrackerIterateAilRoutersHistory (otInstance * aInstance, otHistoryTrackerIterator * aIterator, uint32_t * aEntryAge)

Iterates over the entries in the BR AIL routers history list.

Requires OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE (device acting as Border Router).

Returns

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

otHistoryTrackerEntryAgeToString#

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

Converts a given entry age to a human-readable string.

The entry age string follows the format hours:minutes:seconds:milliseconds (if shorter than one day) or days:hours:minutes:seconds(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.