kiss-lang/lime
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update ThreadPool constructor documentation (closes #1772).

Browse Source
This commit is contained in:
Joseph Cloutier
2024-03-26 13:11:37 -04:00
parent f8f97b5771
commit 093cd6a592
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/lime/system/ThreadPool.hx
View File

@@ -165,8 +165,11 @@ class ThreadPool extends WorkOutput
/** /**
__Call this only from the main thread.__ __Call this only from the main thread.__
@param doWork A single function capable of performing all of this pool's @param minThreads The number of threads that will be kept alive at all
jobs. Always provide `doWork`, even though it's marked as optional. times, even if there's no work to do. The threads won't spin up
immediately; only after enough calls to `run()`. Only applies in
multi-threaded mode.
@param maxThreads The maximum number of threads that will run at once.
@param mode Defaults to `MULTI_THREADED` on most targets, but @param mode Defaults to `MULTI_THREADED` on most targets, but
`SINGLE_THREADED` in HTML5. In HTML5, `MULTI_THREADED` mode uses web `SINGLE_THREADED` in HTML5. In HTML5, `MULTI_THREADED` mode uses web
workers, which impose additional restrictions. workers, which impose additional restrictions.