Memory-managed wrapper type.

Construct a ThreadPool struct initialized to zero.

A convenience alias for Nothing :: Maybe ThreadPool.

Frees all resources allocated for pool.

If immediate is True, no new task is processed for pool. Otherwise pool is not freed before the last task is processed. Note however, that no thread of this pool is interrupted while processing a task. Instead at least all still running threads can finish their tasks before the pool is freed.

If wait_ is True, the functions does not return before all tasks to be processed (dependent on immediate, whether all or only the currently running) are ready. Otherwise the function returns immediately.

After calling this function pool must not be used anymore.

This function will return the maximum interval that a thread will wait in the thread pool for new tasks before being stopped.

If this function returns 0, threads waiting in the thread pool for new work are not stopped.

Since: 2.10

Returns the maximal number of threads for pool.

Returns the maximal allowed number of unused threads.

Returns the number of threads currently running in pool.

Returns the number of currently unused threads.

Moves the item to the front of the queue of unprocessed items, so that it will be processed next.

Since: 2.46

Inserts data into the list of tasks to be executed by pool.

When the number of currently running threads is lower than the maximal allowed number of threads, a new thread is started (or reused) with the properties given to g_thread_pool_new(). Otherwise, data stays in the queue until a thread in this pool finishes its previous task and processes data.

error can be Nothing to ignore errors, or non-Nothing to report errors. An error can only occur when a new thread couldn't be created. In that case data is simply appended to the queue of work to do.

Before version 2.32, this function did not return a success status.

This function will set the maximum interval that a thread waiting in the pool for new tasks can be idle for before being stopped. This function is similar to calling threadPoolStopUnusedThreads on a regular timeout, except this is done on a per thread basis.

By setting interval to 0, idle threads will not be stopped.

The default value is 15000 (15 seconds).

Since: 2.10

Sets the maximal allowed number of threads for pool. A value of -1 means that the maximal number of threads is unlimited. If pool is an exclusive thread pool, setting the maximal number of threads to -1 is not allowed.

Setting maxThreads to 0 means stopping all work for pool. It is effectively frozen until maxThreads is set to a non-zero value again.

A thread is never terminated while calling func, as supplied by g_thread_pool_new(). Instead the maximal number of threads only has effect for the allocation of new threads in threadPoolPush. A new thread is allocated, whenever the number of currently running threads in pool is smaller than the maximal number.

error can be Nothing to ignore errors, or non-Nothing to report errors. An error can only occur when a new thread couldn't be created.

Before version 2.32, this function did not return a success status.

Sets the maximal number of unused threads to maxThreads. If maxThreads is -1, no limit is imposed on the number of unused threads.

The default value is 2.

Stops all currently unused threads. This does not change the maximal number of unused threads. This function can be used to regularly stop all unused threads e.g. from g_timeout_add().

Returns the number of tasks still unprocessed in pool.

Get the value of the “exclusive” field. When overloading is enabled, this is equivalent to

get threadPool #exclusive

Set the value of the “exclusive” field. When overloading is enabled, this is equivalent to

set threadPool [ #exclusive := value ]

Set the value of the “func” field to Nothing. When overloading is enabled, this is equivalent to

clear #func

Get the value of the “func” field. When overloading is enabled, this is equivalent to

get threadPool #func

Set the value of the “func” field. When overloading is enabled, this is equivalent to

set threadPool [ #func := value ]

Set the value of the “user_data” field to Nothing. When overloading is enabled, this is equivalent to

clear #userData

Get the value of the “user_data” field. When overloading is enabled, this is equivalent to

get threadPool #userData

Set the value of the “user_data” field. When overloading is enabled, this is equivalent to

set threadPool [ #userData := value ]