Function openthread_sys::otBorderRoutingGetOmrPrefix

source ·

pub unsafe extern "C" fn otBorderRoutingGetOmrPrefix(
    aInstance: *mut otInstance,
    aPrefix: *mut otIp6Prefix
) -> otError

Expand description

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.

@param[in] aInstance A pointer to an OpenThread instance. @param[out] aPrefix A pointer to where the prefix will be output to.

@retval OT_ERROR_INVALID_STATE The Border Routing Manager is not initialized yet. @retval OT_ERROR_NONE Successfully retrieved the OMR prefix.

@sa otBorderRoutingGetPdOmrPrefix