WPILibC++ 2027.0.0-alpha-5
Loading...
Searching...
No Matches
Threads Functions

Typedefs

typedef const void * NativeThreadHandle

Functions

HAL_Status HAL_GetThreadPriority (NativeThreadHandle handle, int32_t *priority)
 Gets the specified thread's priority.
HAL_Status HAL_GetCurrentThreadPriority (int32_t *priority)
 Gets the current thread's priority.
HAL_Status HAL_SetThreadPriority (NativeThreadHandle handle, int32_t priority)
 Sets the specified thread's priority.
HAL_Status HAL_SetCurrentThreadPriority (int32_t priority)
 Sets the current thread's priority.

Detailed Description

Typedef Documentation

◆ NativeThreadHandle

typedef const void* NativeThreadHandle

Function Documentation

◆ HAL_GetCurrentThreadPriority()

HAL_Status HAL_GetCurrentThreadPriority ( int32_t * priority)

Gets the current thread's priority.

Priorities range from 0 to 99 where 0 is non-real-time, 1-99 are real-time, and 99 is highest priority. See "man 7 sched" for details.

Parameters
[out]priorityThe current thread's priority.
Returns
Error status variable. 0 on success.

◆ HAL_GetThreadPriority()

HAL_Status HAL_GetThreadPriority ( NativeThreadHandle handle,
int32_t * priority )

Gets the specified thread's priority.

Priorities range from 0 to 99 where 0 is non-real-time, 1-99 are real-time, and 99 is highest priority. See "man 7 sched" for details.

Parameters
[in]handleNative thread handle.
[out]priorityThe specified thread's priority.
Returns
Error status variable. 0 on success.

◆ HAL_SetCurrentThreadPriority()

HAL_Status HAL_SetCurrentThreadPriority ( int32_t priority)

Sets the current thread's priority.

Priorities range from 0 to 99 where 0 is non-real-time, 1-99 are real-time, and 99 is highest priority. See "man 7 sched" for details.

Parameters
[in]priorityThe priority.
Returns
Error status variable. 0 on success.

◆ HAL_SetThreadPriority()

HAL_Status HAL_SetThreadPriority ( NativeThreadHandle handle,
int32_t priority )

Sets the specified thread's priority.

Priorities range from 0 to 99 where 0 is non-real-time, 1-99 are real-time, and 99 is highest priority. See "man 7 sched" for details.

Parameters
[in]handleThe native thread handle.
[in]priorityThe priority.
Returns
Error status variable. 0 on success.