ThreadPool::cancel() ​

(PHP 8.6+, True Async 1.0)

public ThreadPool::cancel(): void

Initie un arrêt forcé du pool. Après l'appel à cancel() :

• Tout appel ultérieur à submit() lève immédiatement une Async\ThreadPoolException.
• Les tâches en attente dans la file (pas encore prises en charge par un worker) sont immédiatement rejetées — leurs objets Future correspondants passent à l'état rejeté avec une ThreadPoolException (ou une CancellationException en mode coroutine: true).
• En mode normal (coroutine: false), les tâches déjà en cours d'exécution dans les threads de travail s'exécutent jusqu'à la fin de la tâche courante — interrompre de force du code PHP dans un thread OS n'est pas possible.
• En mode coroutine: true, les tâches in-flight sont réellement cancelées (depuis TrueAsync 0.7.0) : le flag atomique cancel_requested est positionné avant la fermeture du canal, le worker appelle ZEND_ASYNC_SCOPE_CANCEL(pool_scope, NULL, false, false), et AFTER_MAIN annule en cascade tous les scopes enfants des tâches lancées.
• Les workers s'arrêtent dès qu'ils terminent la tâche en cours et ne prennent plus aucune nouvelle tâche dans la file.

Pour un arrêt gracieux qui laisse toutes les tâches en file se terminer, utilisez plutôt close().

Valeur de retour ​

void

Exemples ​

Exemple #1 Annulation forcée avec des tâches en file ​

<?php

use Async\ThreadPool;
use Async\ThreadPoolException;
use function Async\spawn;
use function Async\await;

spawn(function() {
    $pool = new ThreadPool(workers: 2, queueSize: 10);

    // Remplir la file avec 8 tâches réparties sur 2 workers
    $futures = [];
    for ($i = 0; $i < 8; $i++) {
        $futures[] = $pool->submit(function() use ($i) {
            $t = microtime(true);
            while (microtime(true) - $t < 0.2) {}
            return $i;
        });
    }

    // Annulation immédiate — les tâches en file sont rejetées
    $pool->cancel();

    $done = 0;
    $cancelled = 0;
    foreach ($futures as $f) {
        try {
            await($f);
            $done++;
        } catch (ThreadPoolException $e) {
            $cancelled++;
        }
    }

    echo "done:      $done\n";      // 2  (déjà en cours d'exécution lors de cancel())
    echo "cancelled: $cancelled\n"; // 6  (encore dans la file)
});

Voir aussi ​

• ThreadPool::close() — arrêt gracieux
• ThreadPool::isClosed() — vérifier si le pool est fermé
• Async\ThreadPool — vue d'ensemble du composant et comparaison close() vs cancel()