Function linuxcnc_hal_sys::rtapi_prio_highest

pub unsafe extern "C" fn rtapi_prio_highest() -> c_int

The ‘rtapi_prio_xxxx()’ functions provide a portable way to set task priority. The mapping of actual priority to priority number depends on the RTOS. Priorities range from ‘rtapi_prio_lowest()’ to ‘rtapi_prio_highest()’, inclusive. To use this API, use one of two methods:

1. Set your lowest priority task to ‘rtapi_prio_lowest()’, and for each task of the next lowest priority, set their priorities to ‘rtapi_prio_next_higher(previous)’.

2. Set your highest priority task to ‘rtapi_prio_highest()’, and for each task of the next highest priority, set their priorities to ‘rtapi_prio_next_lower(previous)’.

A high priority task will preempt a lower priority task. The linux kernel and userspace are always a lower priority than all rtapi tasks.

Call these functions only from within init/cleanup code, not from realtime tasks.