Border Routing Manager

This module includes configuration variables for Border Routing Manager.

Summary

Macros
OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE 0
Specifies whether to support handling platform generated ND messages.
OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 0
Define to 1 to enable Border Routing Manager feature.
OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES 64
Specifies maximum number of discovered prefixes (on-link prefixes on the infra link) maintained by routing manager.
OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS 16
Specifies maximum number of routers (on infra link) to track by routing manager.
OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES 3
Specifies maximum number of old local on-link prefixes (being deprecated) maintained by routing manager.
OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES 16
Specifies maximum number of on-mesh prefixes (discovered from Thread Network Data) that are included as Route Info Option in emitted Router Advertisement messages.
OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 0
Define to 1 to add mock (empty) implementation of infra-if platform APIs.
OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT (60 * 1000)
Specifies the timeout in msec for a discovered router on infra link side.
OPENTHREAD_CONFIG_BORDER_ROUTING_STUB_ROUTER_FLAG_IN_EMITTED_RA_ENABLE 1
Define to 1 so for the routing manager to include the Flags Extension Option with Stub Router flag in the emitted Router Advertisement messages from this Border Router.
OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 1
Define to 1 to allow using heap by Routing Manager.

Macros

OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE

 OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE 0

Specifies whether to support handling platform generated ND messages.

The desired use case is the prefix will be allocated by other software on the interface, and they will advertise the assigned prefix to the thread interface via router advertisement messages.

OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE

 OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 0

Define to 1 to enable Border Routing Manager feature.

OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES

 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_PREFIXES 64

Specifies maximum number of discovered prefixes (on-link prefixes on the infra link) maintained by routing manager.

Applicable only when heap allocation is not used, i.e., OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE is disabled.

OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS

 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS 16

Specifies maximum number of routers (on infra link) to track by routing manager.

Applicable only when heap allocation is not used, i.e., OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE is disabled. 

 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_OLD_ON_LINK_PREFIXES 3

Specifies maximum number of old local on-link prefixes (being deprecated) maintained by routing manager.

OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES

 OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_ON_MESH_PREFIXES 16

Specifies maximum number of on-mesh prefixes (discovered from Thread Network Data) that are included as Route Info Option in emitted Router Advertisement messages.

OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE

 OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 0

Define to 1 to add mock (empty) implementation of infra-if platform APIs.

This is intended for generating code size report only and should not be used otherwise.

OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT

 OPENTHREAD_CONFIG_BORDER_ROUTING_ROUTER_ACTIVE_CHECK_TIMEOUT (60 * 1000)

Specifies the timeout in msec for a discovered router on infra link side.

This parameter is related to mechanism to check that a discovered router is still active.

After this timeout elapses since the last received message (a Router or Neighbor Advertisement) from the router, routing manager will start sending Neighbor Solidification (NS) probes to the router to check that it is still active.

This parameter can be considered to large value to practically disable this behavior.

OPENTHREAD_CONFIG_BORDER_ROUTING_STUB_ROUTER_FLAG_IN_EMITTED_RA_ENABLE

 OPENTHREAD_CONFIG_BORDER_ROUTING_STUB_ROUTER_FLAG_IN_EMITTED_RA_ENABLE 1

Define to 1 so for the routing manager to include the Flags Extension Option with Stub Router flag in the emitted Router Advertisement messages from this Border Router.

OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE

 OPENTHREAD_CONFIG_BORDER_ROUTING_USE_HEAP_ENABLE 1

Define to 1 to allow using heap by Routing Manager.

When enabled heap allocated entries will be used to track discovered prefix table contain information about discovered routers and the advertised on-link prefixes on infra link.

When disabled pre-allocated pools are used instead where max number of entries are specified by OPENTHREAD_CONFIG_BORDER_ROUTING_MAX_DISCOVERED_ROUTERS and MAX_DISCOVERED_PREFIXES configurations.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.