QThreadPool Class

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

int main()
{
    //...
    HelloWorldTask *hello = new HelloWorldTask();
    // QThreadPool prend en charge la gestion de « hello » et le supprime automatiquement
    QThreadPool::globalInstance()->start(hello);
    //...
}

Documentation des fonctions membres

QThreadPool::QThreadPool(QObject *parent = nullptr)

Crée un pool de threads à l'aide de l'parent fournie.

[virtual noexcept] QThreadPool::~QThreadPool()

Supprime l'QThreadPool. Cette fonction reste bloquée jusqu'à ce que tous les éléments « runnable » aient été exécutés.

void QThreadPool::clear()

Supprime de la file d'attente les éléments « runnable » qui n'ont pas encore été lancés. Les éléments « runnable » pour lesquels la méthode runnable->autoDelete() renvoie la valeur « true » sont supprimés.

Voir également start().

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

Renvoie « true » si « thread » est un thread géré par ce pool de threads.

Cette fonction a été introduite dans Qt 6.0.

[static] QThreadPool *QThreadPool::globalInstance()

Renvoie l'instance globale de ` QThreadPool `.

void QThreadPool::releaseThread()

Libère un thread précédemment réservé par un appel à la fonction ` reserveThread()`.

Voir également reserveThread().

void QThreadPool::reserveThread()

Réserve un thread, sans tenir compte des fonctions ` activeThreadCount()` et ` maxThreadCount()`.

Une fois que vous avez fini d'utiliser le thread, appelez releaseThread() pour permettre sa réutilisation.

Voir également releaseThread().

[since 6.9] QThread::QualityOfService QThreadPool::serviceLevel() const

Renvoie le niveau actuel de qualité de service (QoS) du thread.

Cette fonction a été introduite dans Qt 6.9.

Voir également setServiceLevel() et QThread::serviceLevel().

[since 6.9] void QThreadPool::setServiceLevel(QThread::QualityOfService serviceLevel)

Définit le niveau de qualité de service des objets thread créés après l'appel de ce setter sur « serviceLevel ».

Cette fonctionnalité n'est pas disponible sur toutes les plateformes. Consultez QThread::setServiceLevel() pour plus de détails.

Cette fonction a été introduite dans Qt 6.9.

Voir également serviceLevel() et QThread::serviceLevel().

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

Réserve un thread et l'utilise pour exécuter runnable, sauf si ce thread fait passer le nombre de threads actifs au-delà de la valeur définie par maxThreadCount(). Dans ce cas, runnable est ajouté à une file d'attente d'exécution. L'argument priority permet de contrôler l'ordre d'exécution dans la file d'attente.

Notez que le pool de threads prend possession de l’ runnable si runnable->autoDelete() renvoie true, et que l’ runnable sera automatiquement supprimé par le pool de threads après le retour de runnable->run(). Si runnable->autoDelete() renvoie false, la propriété de runnable reste acquise à l’appelant. Notez que la modification de la suppression automatique sur runnable après l’appel de cette fonction entraîne un comportement indéfini.

template <typename Callable> requires QRunnable::if_callable<Callable> void QThreadPool::start(Callable &&callableToRun, int priority = 0)

Réserve un thread et l'utilise pour exécuter callableToRun, à moins que ce thread ne fasse dépasser le nombre de threads actifs à maxThreadCount(). Dans ce cas, callableToRun est ajouté à une file d'attente d'exécution à la place. L'argument priority peut être utilisé pour contrôler l'ordre d'exécution de la file d'attente.

Contraintes

Ne participe à la résolution des surcharges que si ` Callable ` est une fonction ou un objet fonction pouvant être appelé sans argument.

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

Libère un thread précédemment réservé avec la fonction ` reserveThread()` et l'utilise pour exécuter la fonction ` runnable`.

Notez que le pool de threads prend possession de l’ runnable si runnable->autoDelete() renvoie true, et que l’ runnable sera automatiquement supprimé par le pool de threads après le retour de runnable->run(). Si runnable->autoDelete() renvoie false, la propriété de runnable reste acquise à l’appelant. Notez que la modification de la suppression automatique sur runnable après l’appel de cette fonction entraîne un comportement indéfini.

Cette fonction a été introduite dans Qt 6.3.

Voir également reserveThread() et start().

[since 6.3] template <typename Callable> requires QRunnable::if_callable<Callable> void QThreadPool::startOnReservedThread(Callable &&callableToRun)

Libère un thread précédemment réservé avec la fonction ` reserveThread()` et l'utilise pour exécuter ` callableToRun`.

Contraintes

Ne participe à la résolution des surcharges que si ` Callable ` est une fonction ou un objet-fonction pouvant être appelé sans argument.

Cette fonction a été introduite dans Qt 6.3.

bool QThreadPool::tryStart(QRunnable *runnable)

Tente de réserver un thread pour exécuter runnable.

Si aucun thread n’est disponible au moment de l’appel, cette fonction ne fait rien et renvoie false. Sinon, runnable est exécuté immédiatement à l’aide d’un thread disponible et cette fonction renvoie true.

Notez qu’en cas de réussite, le pool de threads prend possession de l’ runnable si runnable->autoDelete() renvoie true, et l’ runnable sera automatiquement supprimé par le pool de threads après le retour de runnable->run(). Si runnable->autoDelete() renvoie false, la propriété de runnable reste acquise à l’appelant. Notez que la modification de la suppression automatique de runnable après l’appel de cette fonction entraîne un comportement indéfini.

template <typename Callable> requires QRunnable::if_callable<Callable> bool QThreadPool::tryStart(Callable &&callableToRun)

Tente de réserver un thread pour exécuter callableToRun.

Si aucun thread n'est disponible au moment de l'appel, cette fonction ne fait rien et renvoie false. Dans le cas contraire, callableToRun est exécuté immédiatement à l'aide d'un thread disponible et cette fonction renvoie true.

Contraintes

Ne participe à la résolution des surcharges que si ` Callable ` est une fonction ou un objet-fonction pouvant être appelé sans argument.

bool QThreadPool::tryTake(QRunnable *runnable)

Tente de supprimer l'élément « runnable » spécifié de la file d'attente s'il n'a pas encore été lancé. Si l'élément « runnable » n'a pas été lancé, renvoie « true », et la propriété de « runnable » est transférée à l'appelant (même lorsque « runnable->autoDelete() == true »). Sinon, renvoie « false ».

Voir également start() et QRunnable::autoDelete().

[since 6.8] bool QThreadPool::waitForDone(QDeadlineTimer deadline = QDeadlineTimer::Forever)

Attend que la durée d'deadline soit écoulée pour que tous les threads se terminent, puis supprime tous les threads du pool de threads. Renvoie true si tous les threads ont été supprimés ; sinon, elle renvoie false.

Cette fonction a été introduite dans Qt 6.8.

bool QThreadPool::waitForDone(int msecs)

Attend jusqu'à msecs millisecondes que tous les threads se terminent, puis supprime tous les threads du pool de threads. Renvoie true si tous les threads ont été supprimés ; sinon, elle renvoie false. Si msecs est égal à -1, cette fonction attend que le dernier thread se termine.