Thread Pool¶

1

import "std/os/thread-pool";

ThreadPool struct¶

A thread pool that can be used to run multiple jobs in parallel. Thread pools in Spice work with a fixed number of worker threads, that are created when the pool is started. After that, an arbitrary number of jobs can be queued to be run by the pool. The pool will then run as many jobs as possible in parallel.

Constructors¶

ctor¶

1

public p ThreadPool.ctor(unsigned short workerThreadCount = 0s)

Create a new thread pool.

Parameters

Methods¶

start¶

1

public p ThreadPool.start()

Start the thread pool.

stop¶

1

public p ThreadPool.stop()

Finish the running jobs and stop the thread pool.

join¶

1

public p ThreadPool.join()

Wait for all queued jobs to finish and stop the thread pool.

enqueue¶

1

public p ThreadPool.enqueue(const p()& job)

Enqueue a job to be run by the thread pool.

Parameters

pause¶

1

public p ThreadPool.pause()

Pause the thread pool. The worker threads will finish their current job and then wait for the pool to be resumed.

resume¶

1

public p ThreadPool.resume()

Resume the thread pool.

isPaused¶

1

public f<bool> ThreadPool.isPaused()

Check if the thread pool is paused.

Returns: bool

getRunningJobCount¶

1

public f<unsigned short> ThreadPool.getRunningJobCount()

Retrieve the number of jobs that are currently running.

Returns: unsigned short

getQueuedJobCount¶

1

public f<unsigned short> ThreadPool.getQueuedJobCount()

Retrieve the number of jobs that are currently queued.

Returns: unsigned short

getWorkerThreadCount¶

1

public f<unsigned short> ThreadPool.getWorkerThreadCount()

Retrieve the number of worker threads.

Returns: unsigned short