Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-07-14 00:07:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixup docs for TP release

Browse source
This commit is contained in:
Justin Ethier 2019-07-02 13:12:37 -04:00
parent 46de4b9049
commit 9a792617d5
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/api/cyclone/concurrent.md
View file

@ -327,10 +327,8 @@ Add a new task to the given thread pool `tp`.
### thread-pool-release! ### thread-pool-release!
(thread-pool-release! tp [how]) (thread-pool-release! tp)
Call this if the thread pool `tp` will no longer be used. All thread pool threads are stopped and cleaned up by the system. Call this if the thread pool `tp` will no longer be used. Stops and cleans up all thread pool threads.
Note that if `how` is passed `'terminate` the threads will be stopped immediately using `thread-terminate!`. This is a potentially unsafe operation. Otherwise the threads will be stopped in a safe manner.