luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-14 19:55:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

gthreadpool: Document that g_thread_pool_new() will spawn a thread

Browse Source 
Otherwise it might look like it would only start spawning threads when
jobs are enqueued.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Helps: #2958
This commit is contained in:
Philip Withnall 2023-04-28 10:52:22 +01:00
parent 9b8369852b
commit e7398198c5
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
glib/gthreadpool.c
View File

@ -536,10 +536,14 @@ g_thread_pool_start_thread (GRealThreadPool *pool,
* since their threads are never considered idle and returned to the * since their threads are never considered idle and returned to the
* global pool. * global pool.
* *
* Note that the threads used by exclusive threadpools will all inherit the * Note that the threads used by exclusive thread pools will all inherit the
* scheduler settings of the current thread while the threads used by * scheduler settings of the current thread while the threads used by
* non-exclusive threadpools will inherit the scheduler settings from the * non-exclusive thread pools will inherit the scheduler settings from the
* first thread that created such a threadpool. * first thread that created such a thread pool.
*
* At least one thread will be spawned when this function is called, either to
* create the @max_threads exclusive threads, or to preserve the scheduler
* settings of the current thread for future spawns.
* *
* @error can be %NULL to ignore errors, or non-%NULL to report * @error can be %NULL to ignore errors, or non-%NULL to report
* errors. An error can only occur when @exclusive is set to %TRUE * errors. An error can only occur when @exclusive is set to %TRUE