Imagelibrary/rtems
1
0
Fork 1
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2025-12-05 23:23:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

score: Document Thread_Life_state

Browse Source
This commit is contained in:
Sebastian Huber
2021-01-29 08:22:31 +01:00
parent 51e59d59b7
commit 05da65c297
1 changed files with 40 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
cpukit/include/rtems/score/thread.h
View File

@@ -659,20 +659,57 @@ typedef struct {
} Thread_Action_control; } Thread_Action_control;
/** /**
* @brief Thread life states. * @brief This type represents the thread life state.
* *
* The thread life states are orthogonal to the thread states used for * The thread life state is orthogonal to the thread state used for
* synchronization primitives and blocking operations. They reflect the state * synchronization primitives and blocking operations. They reflect the state
* changes triggered with thread restart and delete requests. * changes triggered with thread restart and delete requests.
* *
* The individual state values must be a power of two to allow use of bit * The individual state flags must be a power of two to allow use of bit
* operations to manipulate and evaluate the thread life state. * operations to manipulate and evaluate the thread life state.
*/ */
typedef enum { typedef enum {
/**
* @brief Indicates that the thread life is protected.
*
* If this flag is set, then the thread restart or delete requests are deferred
* until the protection and deferred change flags are cleared. It is used by
* _Thread_Set_life_protection().
*/
THREAD_LIFE_PROTECTED = 0x1, THREAD_LIFE_PROTECTED = 0x1,
/**
* @brief Indicates that thread is restarting.
*
* If this flag is set, then a thread restart request is in pending. See
* _Thread_Restart_self() and _Thread_Restart_other().
*/
THREAD_LIFE_RESTARTING = 0x2, THREAD_LIFE_RESTARTING = 0x2,
/**
* @brief Indicates that thread is terminating.
*
* If this flag is set, then a thread termination request is in pending. See
* _Thread_Exit() and _Thread_Cancel().
*/
THREAD_LIFE_TERMINATING = 0x4, THREAD_LIFE_TERMINATING = 0x4,
/**
* @brief Indicates that thread life changes are deferred.
*
* If this flag is set, then the thread restart or delete requests are deferred
* until the protection and deferred change flags are cleared. It is used by
* pthread_setcanceltype().
*/
THREAD_LIFE_CHANGE_DEFERRED = 0x8, THREAD_LIFE_CHANGE_DEFERRED = 0x8,
/**
* @brief Indicates that thread is detached.
*
* If this flag is set, then the thread is detached. Detached threads do not
* wait during termination for other threads to join. See rtems_task_delete(),
* rtems_task_exit(), and pthread_detach().
*/
THREAD_LIFE_DETACHED = 0x10 THREAD_LIFE_DETACHED = 0x10
} Thread_Life_state; } Thread_Life_state;