Changeset 05da65c in rtems


Ignore:
Timestamp:
Jan 29, 2021, 7:22:31 AM (3 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
56494ed8
Parents:
51e59d5
git-author:
Sebastian Huber <sebastian.huber@…> (01/29/21 07:22:31)
git-committer:
Sebastian Huber <sebastian.huber@…> (02/01/21 09:15:57)
Message:

score: Document Thread_Life_state

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/thread.h

    r51e59d5 r05da65c  
    660660
    661661/**
    662  * @brief Thread life states.
    663  *
    664  * The thread life states are orthogonal to the thread states used for
     662 * @brief This type represents the thread life state.
     663 *
     664 * The thread life state is orthogonal to the thread state used for
    665665 * synchronization primitives and blocking operations.  They reflect the state
    666666 * changes triggered with thread restart and delete requests.
    667667 *
    668  * The individual state values must be a power of two to allow use of bit
     668 * The individual state flags must be a power of two to allow use of bit
    669669 * operations to manipulate and evaluate the thread life state.
    670670 */
    671671typedef enum {
     672  /**
     673   * @brief Indicates that the thread life is protected.
     674   *
     675   * If this flag is set, then the thread restart or delete requests are deferred
     676   * until the protection and deferred change flags are cleared.  It is used by
     677   * _Thread_Set_life_protection().
     678   */
    672679  THREAD_LIFE_PROTECTED = 0x1,
     680
     681  /**
     682   * @brief Indicates that thread is restarting.
     683   *
     684   * If this flag is set, then a thread restart request is in pending. See
     685   * _Thread_Restart_self() and _Thread_Restart_other().
     686   */
    673687  THREAD_LIFE_RESTARTING = 0x2,
     688
     689  /**
     690   * @brief Indicates that thread is terminating.
     691   *
     692   * If this flag is set, then a thread termination request is in pending.  See
     693   * _Thread_Exit() and _Thread_Cancel().
     694   */
    674695  THREAD_LIFE_TERMINATING = 0x4,
     696
     697  /**
     698   * @brief Indicates that thread life changes are deferred.
     699   *
     700   * If this flag is set, then the thread restart or delete requests are deferred
     701   * until the protection and deferred change flags are cleared.  It is used by
     702   * pthread_setcanceltype().
     703   */
    675704  THREAD_LIFE_CHANGE_DEFERRED = 0x8,
     705
     706  /**
     707   * @brief Indicates that thread is detached.
     708   *
     709   * If this flag is set, then the thread is detached.  Detached threads do not
     710   * wait during termination for other threads to join.  See rtems_task_delete(),
     711   * rtems_task_exit(), and pthread_detach().
     712   */
    676713  THREAD_LIFE_DETACHED = 0x10
    677714} Thread_Life_state;
Note: See TracChangeset for help on using the changeset viewer.