michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add k_thread_join() to documentation

Browse source 
Added to the section covering thread termination.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2020-02-21 15:37:31 -08:00 • committed by Anas Nashif
commit 806c8af660
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/reference/kernel/threads/index.rst
View file

@ -85,6 +85,12 @@ prior to returning, since the kernel does *not* reclaim them automatically.
The kernel does not currently make any claims regarding an application's The kernel does not currently make any claims regarding an application's
ability to respawn a thread that terminates. ability to respawn a thread that terminates.
In some cases a thread may want to sleep until another thread terminates.
This can be accomplished with the :cpp:func:`k_thread_join()` API. This
will block the calling thread until either the timeout expires, the target
thread self-exits, or the target thread aborts (either due to a
k_thread_abort() call or triggering a fatal error).
Thread Aborting Thread Aborting
=============== ===============