Symbols ![]()
loading...
Files ![]()
loading...
otBorderRoutingPrefixTableIterator struct
All the functions in this module require `OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE` to be enabled. Border Routing Manager handles bi-directional routing between Thread network and adjacent infrastructure link (AIL). It emits ICMRv6 ND Router Advertisement (RA) messages on AIL to advertise on-link and route prefixes. It also processes received RA messages from infrastructure and mirrors the discovered prefixes on the Thread Network Data to ensure devices on Thread mesh can reach AIL through the Border Router. Routing Manager manages the Off-Mesh Routable (OMR) prefix on the Thread Network data which configures Thread devices with a suitable Off-Mesh Routable IPv6 address. It announces the reachability of this prefix on AIL by including it in the emitted RA messages as an IPv6 Route Information Option (RIO). Routing Manager also monitors and adds on-link prefix on the infrastructure network. If a router on AIL is already providing RA messages containing an IPv6 Prefix Information Option (PIO) that enables IPv6 devices on the link to self-configure their own routable unicast IPv6 address, this address can be used by Thread devices to reach AIL. If Border Router finds no such RA message on AIL, it generates a ULA on-link prefix which it then advertises on AIL in the emitted RA messages. Represents an iterator to iterate through the Border Router's discovered prefix table. The fields in this type are opaque (intended for use by OpenThread core only) and therefore should not be accessed or used by caller. Before using an iterator, it MUST be initialized using `otBorderRoutingPrefixTableInitIterator()`.
Syntax
Fields
Field
Declared as
const void *
const void *
Related Functions
Found 12 other functions taking a otBorderRoutingPrefixTableIterator
argument:
Function
Description
Initializes an `otBorderRoutingPrefixTableIterator`. An iterator MUST be initialized before it is used. An iterator can be initialized again to restart from the beginning of the table. When iterating over entries in the table, to ensure the update times `mMsecSinceLastUpdate` of entries are consistent, they are given relative to the time the iterator was initialized.
Iterates over the entries in the Border Router's discovered prefix table. Prefix entries associated with the same discovered router on an infrastructure link are guaranteed to be grouped together (retrieved back-to-back).
Iterates over the discovered router entries on the infrastructure link.
Iterates over the peer BRs found in the Network Data. Requires `OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE`. Peer BRs are other devices within the Thread mesh that provide external IP connectivity. A device is considered to provide external IP connectivity if at least one of the following conditions is met regarding its Network Data entries: - It has added at least one external route entry. - It has added at least one prefix entry with both the default-route and on-mesh flags set. - It has added at least one domain prefix (with both the domain and on-mesh flags set). The list of peer BRs specifically excludes the current device, even if it is itself acting as a BR.
Initializes a `PrefixTableIterator`. An iterator can be initialized again to start from the beginning of the table. When iterating over entries in the table, to ensure the entry update times are consistent, they are given relative to the time the iterator was initialized.
Iterates over entries in the discovered prefix table.
Iterates over discovered router entries on infrastructure link.
Iterates over the peer BRs found in the Network Data.