openthread_sys

Function otSrpServerSetAutoEnableMode

Source
pub unsafe extern "C" fn otSrpServerSetAutoEnableMode(
    aInstance: *mut otInstance,
    aEnabled: bool,
)
Expand description

Enables/disables the auto-enable mode on SRP server.

Requires OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE feature.

When this mode is enabled, the Border Routing Manager controls if/when to enable or disable the SRP server. SRP sever is auto-enabled if/when Border Routing is started and it is done with the initial prefix and route configurations (when the OMR and on-link prefixes are determined, advertised in emitted Router Advertisement message on infrastructure side and published in the Thread Network Data). The SRP server is auto-disabled if/when BR is stopped (e.g., if the infrastructure network interface is brought down or if BR gets detached).

This mode can be disabled by a otSrpServerSetAutoEnableMode() call with @p aEnabled set to false or if the SRP server is explicitly enabled or disabled by a call to otSrpServerSetEnabled() function. Disabling auto-enable mode using otSrpServerSetAutoEnableMode(false) will not change the current state of SRP sever (e.g., if it is enabled it stays enabled).

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aEnabled A boolean to enable/disable the auto-enable mode.