Function openthread_sys::otThreadReleaseRouterId

source ·

pub unsafe extern "C" fn otThreadReleaseRouterId(
    aInstance: *mut otInstance,
    aRouterId: u8
) -> otError

Expand description

Release a Router ID that has been allocated by the device in the Leader role.

@note This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aRouterId The Router ID to release. Valid range is [0, 62].

@retval OT_ERROR_NONE Successfully released the router id. @retval OT_ERROR_INVALID_ARGS @p aRouterId is not in the range [0, 62]. @retval OT_ERROR_INVALID_STATE The device is not currently operating as a leader. @retval OT_ERROR_NOT_FOUND The router id is not currently allocated.