QThreadPool Class

class HelloWorldTask : public QRunnable
{
    void run() override
    {
        qDebug() << "Hello world from thread" << QThread::currentThread();
    }
};

HelloWorldTask *hello = new HelloWorldTask();
// QThreadPool takes ownership and deletes 'hello' automatically
QThreadPool::globalInstance()->start(hello);

Member Function Documentation

QThreadPool::QThreadPool(QObject *parent = nullptr)

Constructs a thread pool with the given parent.

[virtual] QThreadPool::~QThreadPool()

Destroys the QThreadPool. This function will block until all runnables have been completed.

[since 5.2] void QThreadPool::clear()

Removes the runnables that are not yet started from the queue. The runnables for which runnable->autoDelete() returns true are deleted.

This function was introduced in Qt 5.2.

See also start().

[since 6.0] bool QThreadPool::contains(const QThread *thread) const

Returns true if thread is a thread managed by this thread pool.

This function was introduced in Qt 6.0.

[static] QThreadPool *QThreadPool::globalInstance()

Returns the global QThreadPool instance.

void QThreadPool::releaseThread()

Releases a thread previously reserved by a call to reserveThread().

See also reserveThread().

void QThreadPool::reserveThread()

Reserves one thread, disregarding activeThreadCount() and maxThreadCount().

Once you are done with the thread, call releaseThread() to allow it to be reused.

See also releaseThread().

void QThreadPool::start(QRunnable *runnable, int priority = 0)

Reserves a thread and uses it to run runnable, unless this thread will make the current thread count exceed maxThreadCount(). In that case, runnable is added to a run queue instead. The priority argument can be used to control the run queue's order of execution.

Note that the thread pool takes ownership of the runnable if runnable->autoDelete() returns true, and the runnable will be deleted automatically by the thread pool after the runnable->run() returns. If runnable->autoDelete() returns false, ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this functions results in undefined behavior.

[since 5.15] void QThreadPool::start(std::function<void ()> functionToRun, int priority = 0)

This is an overloaded function.

Reserves a thread and uses it to run functionToRun, unless this thread will make the current thread count exceed maxThreadCount(). In that case, functionToRun is added to a run queue instead. The priority argument can be used to control the run queue's order of execution.

This function was introduced in Qt 5.15.

[since 6.3] void QThreadPool::startOnReservedThread(QRunnable *runnable)

Releases a thread previously reserved with reserveThread() and uses it to run runnable.

Note that the thread pool takes ownership of the runnable if runnable->autoDelete() returns true, and the runnable will be deleted automatically by the thread pool after the runnable->run() returns. If runnable->autoDelete() returns false, ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this functions results in undefined behavior.

This function was introduced in Qt 6.3.

See also reserveThread() and start().

[since 6.3] void QThreadPool::startOnReservedThread(std::function<void ()> functionToRun)

This is an overloaded function.

Releases a thread previously reserved with reserveThread() and uses it to run functionToRun.

This function was introduced in Qt 6.3.

bool QThreadPool::tryStart(QRunnable *runnable)

Attempts to reserve a thread to run runnable.

If no threads are available at the time of calling, then this function does nothing and returns false. Otherwise, runnable is run immediately using one available thread and this function returns true.

Note that on success the thread pool takes ownership of the runnable if runnable->autoDelete() returns true, and the runnable will be deleted automatically by the thread pool after the runnable->run() returns. If runnable->autoDelete() returns false, ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this function results in undefined behavior.

[since 5.15] bool QThreadPool::tryStart(std::function<void ()> functionToRun)

This is an overloaded function.

Attempts to reserve a thread to run functionToRun.

If no threads are available at the time of calling, then this function does nothing and returns false. Otherwise, functionToRun is run immediately using one available thread and this function returns true.

This function was introduced in Qt 5.15.

[since 5.9] bool QThreadPool::tryTake(QRunnable *runnable)

Attempts to remove the specified runnable from the queue if it is not yet started. If the runnable had not been started, returns true, and ownership of runnable is transferred to the caller (even when runnable->autoDelete() == true). Otherwise returns false.

This function was introduced in Qt 5.9.

See also start() and QRunnable::autoDelete().

bool QThreadPool::waitForDone(int msecs = -1)

Waits up to msecs milliseconds for all threads to exit and removes all threads from the thread pool. Returns true if all threads were removed; otherwise it returns false. If msecs is -1 (the default), the timeout is ignored (waits for the last thread to exit).