Border Routing Manager#

otBorderRoutingState#

otBorderRoutingState

Represents the state of Border Routing Manager.

otBorderRoutingDhcp6PdState#

otBorderRoutingDhcp6PdState

This enumeration represents the state of DHCPv6 Prefix Delegation State.

otBorderRoutingPrefixTableIterator#

typedef struct otBorderRoutingPrefixTableIterator otBorderRoutingPrefixTableIterator

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().

otBorderRoutingRouterEntry#

typedef struct otBorderRoutingRouterEntry otBorderRoutingRouterEntry

Represents a discovered router on the infrastructure link.

The mIsPeerBr field requires OPENTHREAD_CONFIG_BORDER_ROUTING_TRACK_PEER_BR_INFO_ENABLE. Routing Manager determines whether the router is a peer BR (connected to the same Thread mesh network) by comparing its advertised PIO/RIO prefixes with the entries in the Thread Network Data. While this method is generally effective, it may not be 100% accurate in all scenarios, so the mIsPeerBr flag should be used with caution.

otBorderRoutingPrefixTableEntry#

typedef struct otBorderRoutingPrefixTableEntry otBorderRoutingPrefixTableEntry

Represents an entry from the discovered prefix table.

The entries in the discovered table track the Prefix/Route Info Options in the received Router Advertisement messages from other routers on the infrastructure link.

otBorderRoutingPeerBorderRouterEntry#

typedef struct otBorderRoutingPeerBorderRouterEntry otBorderRoutingPeerBorderRouterEntry

Represents information about a peer Border Router found in the Network Data.

otPdProcessedRaInfo#

typedef struct otPdProcessedRaInfo otPdProcessedRaInfo

Represents a group of data of platform-generated RA messages processed.

otBorderRoutingRequestDhcp6PdCallback#

typedef void(* otBorderRoutingRequestDhcp6PdCallback) (otBorderRoutingDhcp6PdState aState, void *aContext) )(otBorderRoutingDhcp6PdState aState, void *aContext)

When the state of a DHCPv6 Prefix Delegation (PD) on the Thread interface changes, this callback notifies processes in the OS of this changed state.

otBorderRoutingInit#

otError otBorderRoutingInit (otInstance * aInstance, uint32_t aInfraIfIndex, bool aInfraIfIsRunning)

Initializes the Border Routing Manager on given infrastructure interface.

Note

• This method MUST be called before any other otBorderRouting* APIs.

• This method can be re-called to change the infrastructure interface, but the Border Routing Manager should be disabled first, and re-enabled after.

See Also

• otPlatInfraIfStateChanged.

• otBorderRoutingSetEnabled.

otBorderRoutingSetEnabled#

otError otBorderRoutingSetEnabled (otInstance * aInstance, bool aEnabled)

Enables or disables the Border Routing Manager.

Note

• The Border Routing Manager is disabled by default.

otBorderRoutingGetState#

otBorderRoutingState otBorderRoutingGetState (otInstance * aInstance)

Gets the current state of Border Routing Manager.

Returns

• The current state of Border Routing Manager.

otBorderRoutingGetRouteInfoOptionPreference#

otRoutePreference otBorderRoutingGetRouteInfoOptionPreference (otInstance * aInstance)

Gets the current preference used when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.

The RIO preference is determined as follows:

• If explicitly set by user by calling otBorderRoutingSetRouteInfoOptionPreference(), the given preference is used.

• Otherwise, it is determined based on device's current role: Medium preference when in router/leader role and low preference when in child role.

Returns

• The current Route Info Option preference.

otBorderRoutingSetRouteInfoOptionPreference#

void otBorderRoutingSetRouteInfoOptionPreference (otInstance * aInstance, otRoutePreference aPreference)

Explicitly sets the preference to use when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.

After a call to this function, BR will use the given preference for all its advertised RIOs. The preference can be cleared by calling otBorderRoutingClearRouteInfoOptionPreference().

otBorderRoutingClearRouteInfoOptionPreference#

void otBorderRoutingClearRouteInfoOptionPreference (otInstance * aInstance)

Clears a previously set preference value for advertised Route Info Options.

After a call to this function, BR will use device's role to determine the RIO preference: Medium preference when in router/leader role and low preference when in child role.

otBorderRoutingSetExtraRouterAdvertOptions#

otError otBorderRoutingSetExtraRouterAdvertOptions (otInstance * aInstance, const uint8_t * aOptions, uint16_t aLength)

Sets additional options to append at the end of emitted Router Advertisement (RA) messages.

The content of aOptions is copied internally, so it can be a temporary buffer (e.g., a stack allocated array).

Subsequent calls to this function overwrite the previously set value.

otBorderRoutingGetRoutePreference#

otRoutePreference otBorderRoutingGetRoutePreference (otInstance * aInstance)

Gets the current preference used for published routes in Network Data.

The preference is determined as follows:

• If explicitly set by user by calling otBorderRoutingSetRoutePreference(), the given preference is used.

• Otherwise, it is determined automatically by RoutingManager based on the device's role and link quality.

Returns

• The current published route preference.

otBorderRoutingSetRoutePreference#

void otBorderRoutingSetRoutePreference (otInstance * aInstance, otRoutePreference aPreference)

Explicitly sets the preference of published routes in Network Data.

After a call to this function, BR will use the given preference. The preference can be cleared by calling otBorderRoutingClearRoutePreference().

otBorderRoutingClearRoutePreference#

void otBorderRoutingClearRoutePreference (otInstance * aInstance)

Clears a previously set preference value for published routes in Network Data.

After a call to this function, BR will determine the preference automatically based on the device's role and link quality (to the parent when acting as end-device).

otBorderRoutingGetOmrPrefix#

otError otBorderRoutingGetOmrPrefix (otInstance * aInstance, otIp6Prefix * aPrefix)

Gets the local Off-Mesh-Routable (OMR) Prefix, for example fdfc:1ff5:1512:5622::/64.

An OMR Prefix is a randomly generated 64-bit prefix that's published in the Thread network if there isn't already an OMR prefix. This prefix can be reached from the local Wi-Fi or Ethernet network.

Note: When DHCPv6 PD is enabled, the border router may publish the prefix from DHCPv6 PD.

See Also

• otBorderRoutingGetPdOmrPrefix

otBorderRoutingGetPdOmrPrefix#

otError otBorderRoutingGetPdOmrPrefix (otInstance * aInstance, otBorderRoutingPrefixTableEntry * aPrefixInfo)

Gets the DHCPv6 Prefix Delegation (PD) provided off-mesh-routable (OMR) prefix.

Only mPrefix, mValidLifetime and mPreferredLifetime fields are used in the returned prefix info.

OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE must be enabled.

See Also

• otBorderRoutingGetOmrPrefix

• otPlatBorderRoutingProcessIcmp6Ra

otBorderRoutingGetPdProcessedRaInfo#

otError otBorderRoutingGetPdProcessedRaInfo (otInstance * aInstance, otPdProcessedRaInfo * aPdProcessedRaInfo)

Gets the data of platform generated RA message processed.

OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE must be enabled.

otBorderRoutingGetFavoredOmrPrefix#

otError otBorderRoutingGetFavoredOmrPrefix (otInstance * aInstance, otIp6Prefix * aPrefix, otRoutePreference * aPreference)

Gets the currently favored Off-Mesh-Routable (OMR) Prefix.

The favored OMR prefix can be discovered from Network Data or can be this device's local OMR prefix.

otBorderRoutingGetOnLinkPrefix#

otError otBorderRoutingGetOnLinkPrefix (otInstance * aInstance, otIp6Prefix * aPrefix)

Gets the local On-Link Prefix for the adjacent infrastructure link.

The local On-Link Prefix is a 64-bit prefix that's advertised on the infrastructure link if there isn't already a usable on-link prefix being advertised on the link.

otBorderRoutingGetFavoredOnLinkPrefix#

otError otBorderRoutingGetFavoredOnLinkPrefix (otInstance * aInstance, otIp6Prefix * aPrefix)

Gets the currently favored On-Link Prefix.

The favored prefix is either a discovered on-link prefix on the infrastructure link or the local on-link prefix.

otBorderRoutingGetNat64Prefix#

otError otBorderRoutingGetNat64Prefix (otInstance * aInstance, otIp6Prefix * aPrefix)

Gets the local NAT64 Prefix of the Border Router.

NAT64 Prefix might not be advertised in the Thread network.

OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE must be enabled.

otBorderRoutingGetFavoredNat64Prefix#

otError otBorderRoutingGetFavoredNat64Prefix (otInstance * aInstance, otIp6Prefix * aPrefix, otRoutePreference * aPreference)

Gets the currently favored NAT64 prefix.

The favored NAT64 prefix can be discovered from infrastructure link or can be this device's local NAT64 prefix.

otBorderRoutingPrefixTableInitIterator#

void otBorderRoutingPrefixTableInitIterator (otInstance * aInstance, otBorderRoutingPrefixTableIterator * aIterator)

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.

otBorderRoutingGetNextPrefixTableEntry#

otError otBorderRoutingGetNextPrefixTableEntry (otInstance * aInstance, otBorderRoutingPrefixTableIterator * aIterator, otBorderRoutingPrefixTableEntry * aEntry)

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).

otBorderRoutingGetNextRouterEntry#

otError otBorderRoutingGetNextRouterEntry (otInstance * aInstance, otBorderRoutingPrefixTableIterator * aIterator, otBorderRoutingRouterEntry * aEntry)

Iterates over the discovered router entries on the infrastructure link.

otBorderRoutingGetNextPeerBrEntry#

otError otBorderRoutingGetNextPeerBrEntry (otInstance * aInstance, otBorderRoutingPrefixTableIterator * aIterator, otBorderRoutingPeerBorderRouterEntry * aEntry)

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.

otBorderRoutingCountPeerBrs#

uint16_t otBorderRoutingCountPeerBrs (otInstance * aInstance, uint32_t * aMinAge)

Returns the number of 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.

Returns

• The number of peer BRs.

otBorderRoutingDhcp6PdSetEnabled#

void otBorderRoutingDhcp6PdSetEnabled (otInstance * aInstance, bool aEnabled)

Enables / Disables DHCPv6 Prefix Delegation.

OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE must be enabled.

otBorderRoutingDhcp6PdGetState#

otBorderRoutingDhcp6PdState otBorderRoutingDhcp6PdGetState (otInstance * aInstance)

Gets the current state of DHCPv6 Prefix Delegation.

Requires OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE to be enabled.

Returns

• The current state of DHCPv6 Prefix Delegation.

otBorderRoutingDhcp6PdSetRequestCallback#

void otBorderRoutingDhcp6PdSetRequestCallback (otInstance * aInstance, otBorderRoutingRequestDhcp6PdCallback aCallback, void * aContext)

Sets the callback whenever the DHCPv6 PD state changes on the Thread interface.

Subsequent calls to this function replace the previously set callback.

otBorderRoutingSetOnLinkPrefix#

void otBorderRoutingSetOnLinkPrefix (otInstance * aInstance, const otIp6Prefix * aPrefix)

Sets the local on-link prefix.

Requires OPENTHREAD_CONFIG_BORDER_ROUTING_TESTING_API_ENABLE.

This is intended for testing only and using it will make the BR non-compliant with the Thread Specification.