Skip to main content

otHistoryTrackerIterateFavoredOnLinkPrefixHistory

openthread_sys

Function otHistoryTrackerIterateFavoredOnLinkPrefixHistory 

Source 
pub unsafe extern "C" fn otHistoryTrackerIterateFavoredOnLinkPrefixHistory(
    aInstance: *mut otInstance,
    aIterator: *mut otHistoryTrackerIterator,
    aEntryAge: *mut u32,
) -> *const otHistoryTrackerFavoredOnLinkPrefix
Expand description

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

Requires OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE (device acting as Border Router).

@param[in] aInstance A pointer to the OpenThread instance. @param[in,out] aIterator A pointer to an iterator. MUST be initialized or the behavior is undefined. @param[out] aEntryAge A pointer to a variable to output the entry’s age. MUST NOT be NULL. Age is provided as the duration (in milliseconds) from when the entry was recorded to @p aIterator initialization time. It is set to OT_HISTORY_TRACKER_MAX_AGE for entries older than the max age.

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