Function openthread_sys::otThreadSetRouterEligible

source ·

pub unsafe extern "C" fn otThreadSetRouterEligible(
    aInstance: *mut otInstance,
    aEligible: bool
) -> otError

Expand description

Sets whether or not the device is router-eligible.

If @p aEligible is false and the device is currently operating as a router, this call will cause the device to detach and attempt to reattach as a child.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aEligible TRUE to configure the device as router-eligible, FALSE otherwise.

@retval OT_ERROR_NONE Successfully set the router-eligible configuration. @retval OT_ERROR_NOT_CAPABLE The device is not capable of becoming a router.