Function otBorderRoutingSetOmrConfig

pub unsafe extern "C" fn otBorderRoutingSetOmrConfig(
    aInstance: *mut otInstance,
    aConfig: otBorderRoutingOmrConfig,
    aOmrPrefix: *const otIp6Prefix,
    aPreference: otRoutePreference,
) -> otError

Configures the OMR prefix handling in the Border Routing Manager.

This function offers manual administration options to explicitly configure the OMR prefix or to disable it.

By default, OT_BORDER_ROUTING_OMR_CONFIG_AUTO is used. In this mode, the Border Routing Manager automatically selects and manages the OMR prefix. This can involve auto-generating a local prefix or utilizing a prefix obtained through DHCPv6 PD (Prefix Delegation), if the feature is enabled.

The OT_BORDER_ROUTING_OMR_CONFIG_CUSTOM option enables the use of a user-specified OMR prefix. When this option is selected, the @p aOmrPrefix and @p aPreference parameters are used to define the custom OMR prefix and its associated preference. These parameters are ignored for other configuration modes, and @p aOmrPrefix can be NULL.

The OT_BORDER_ROUTING_OMR_CONFIG_DISABLED option disables the Border Routing Manager’s management of the OMR prefix. The Routing Manager module itself will not add any local or DHCPv6 PD OMR prefixes to the Network Data.

@param[in] aInstance A pointer to the OpenThread instance. @param[in] aConfig The desired OMR configuration. @param[in] aOmrPrefix A pointer to the custom OMR prefix. Required only when @p aConfig is OT_BORDER_ROUTING_OMR_CONFIG_CUSTOM. Otherwise, it can be NULL. @param[in] aPreference The preference associated with the custom OMR prefix.

@retval OT_ERROR_NONE The OMR configuration was successfully set to @p aConfig. @retval OT_ERROR_INVALID_ARGS The provided custom OMR prefix (@p aOmrPrefix) is invalid.