luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

gthreadpool: Mention g_get_num_processors() in the thread pool docs

Browse Source 
Just to make it a little more obvious that a thread pool can be
initialised with one thread per logical CPU.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Fixes: #272
This commit is contained in:
Philip Withnall 2020-07-27 02:17:37 +01:00
parent 5ba5f5b686
commit b3c0c4804b
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
glib/gthreadpool.c
View File

@ -528,6 +528,10 @@ g_thread_pool_start_thread (GRealThreadPool *pool,
* with the two arguments. The first one is the parameter to * with the two arguments. The first one is the parameter to
* g_thread_pool_push() and the second one is @user_data. * g_thread_pool_push() and the second one is @user_data.
* *
* Pass g_get_num_processors() to @max_threads to create as many threads as
* there are logical processors on the system. This will not pin each thread to
* a specific processor.
*
* The parameter @exclusive determines whether the thread pool owns * The parameter @exclusive determines whether the thread pool owns
* all threads exclusive or shares them with other thread pools. * all threads exclusive or shares them with other thread pools.
* If @exclusive is %TRUE, @max_threads threads are started * If @exclusive is %TRUE, @max_threads threads are started