Skip to content

Commit da6571c

Browse files
committed
Add documentation on invalid thread functions in irq
1 parent 21e68f3 commit da6571c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

core/mbed-rtos/rtos/Thread.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ class Thread {
6060

6161
/** Wait for thread to terminate
6262
@return status code that indicates the execution status of the function.
63+
@note not callable from interrupt
6364
*/
6465
osStatus join();
6566

@@ -134,17 +135,20 @@ class Thread {
134135
@param signals wait until all specified signal flags set or 0 for any single signal flag.
135136
@param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
136137
@return event flag information or error code.
138+
@note not callable from interrupt
137139
*/
138140
static osEvent signal_wait(int32_t signals, uint32_t millisec=osWaitForever);
139141

140142
/** Wait for a specified time period in millisec:
141143
@param millisec time delay value
142144
@return status code that indicates the execution status of the function.
145+
@note not callable from interrupt
143146
*/
144147
static osStatus wait(uint32_t millisec);
145148

146149
/** Pass control to next thread that is in state READY.
147150
@return status code that indicates the execution status of the function.
151+
@note not callable from interrupt
148152
*/
149153
static osStatus yield();
150154

0 commit comments

Comments
 (0)