Skip to content

Commit 0b35926

Browse files
committed
RTOS: Thread: Update thread state docs
1 parent 4c489e6 commit 0b35926

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

rtos/Thread.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -253,25 +253,25 @@ class Thread : private mbed::NonCopyable<Thread> {
253253

254254
/** State of the Thread */
255255
enum State {
256-
Inactive, /**< Not created */
256+
Inactive, /**< NOT USED */
257257
Ready, /**< Ready to run */
258258
Running, /**< Running */
259259
WaitingDelay, /**< Waiting for a delay to occur */
260-
WaitingJoin, /**< Waiting for thread to join */
260+
WaitingJoin, /**< Waiting for thread to join. Only happens when using RTX directly. */
261261
WaitingThreadFlag, /**< Waiting for a thread flag to be set */
262262
WaitingEventFlag, /**< Waiting for a event flag to be set */
263263
WaitingMutex, /**< Waiting for a mutex event to occur */
264264
WaitingSemaphore, /**< Waiting for a semaphore event to occur */
265265
WaitingMemoryPool, /**< Waiting for a memory pool */
266266
WaitingMessageGet, /**< Waiting for message to arrive */
267267
WaitingMessagePut, /**< Waiting for message to be send */
268-
WaitingInterval, /**< Waiting for an interval to occur */
269-
WaitingOr, /**< Waiting for one event in a set to occur */
270-
WaitingAnd, /**< Waiting for multiple events in a set to occur */
271-
WaitingMailbox, /**< Waiting for a mailbox event to occur */
268+
WaitingInterval, /**< NOT USED */
269+
WaitingOr, /**< NOT USED */
270+
WaitingAnd, /**< NOT USED */
271+
WaitingMailbox, /**< NOT USED (Mail is implemented as MemoryPool and Queue) */
272272

273273
/* Not in sync with RTX below here */
274-
Deleted, /**< The task has been deleted */
274+
Deleted, /**< The task has been deleted or not started */
275275
};
276276

277277
/** State of this Thread

0 commit comments

Comments
 (0)