ThreadPool::cancel() ​

(PHP 8.6+, True Async 1.0)

public ThreadPool::cancel(): void

Ініціює примусове завершення роботи пулу. Після виклику cancel():

• Будь-який наступний виклик submit() негайно кидає Async\ThreadPoolException.
• Завдання, що очікують у черзі (ще не взяті робочим потоком), негайно відхиляються — відповідні об'єкти Future переходять у стан відхилення з ThreadPoolException (а в режимі coroutine: true — з CancellationException).
• У звичайному режимі (coroutine: false) завдання, що вже виконуються в робочих потоках, доводяться до завершення поточного завдання — примусово перервати PHP-код в OS-потоці неможливо.
• У режимі coroutine: true in-flight завдання реально скасовуються (починаючи з TrueAsync 0.7.0): атомарний прапор cancel_requested виставляється до закриття каналу, воркер викликає ZEND_ASYNC_SCOPE_CANCEL(pool_scope, NULL, false, false), а AFTER_MAIN каскадно скасовує всі child-scope'и запущених завдань.
• Робочі потоки зупиняються, щойно завершать поточне завдання, і більше не беруть нових завдань із черги.

Для м'якого завершення роботи, яке дає можливість виконати всі завдання в черзі, використовуйте натомість close().

Значення, що повертається ​

void

Приклади ​

Приклад #1 Примусова відміна із завданнями в черзі ​

<?php

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

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

    // Заповнюємо чергу 8 завданнями на 2 робочі потоки
    $futures = [];
    for ($i = 0; $i < 8; $i++) {
        $futures[] = $pool->submit(function() use ($i) {
            $t = microtime(true);
            while (microtime(true) - $t < 0.2) {}
            return $i;
        });
    }

    // Скасовуємо негайно — завдання в черзі відхиляються
    $pool->cancel();

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

    echo "done:      $done\n";      // 2  (вже виконувались на момент виклику cancel())
    echo "cancelled: $cancelled\n"; // 6  (ще були в черзі)
});

Дивіться також ​

• ThreadPool::close() — м'яке завершення роботи
• ThreadPool::isClosed() — перевірити, чи закритий пул
• Async\ThreadPool — огляд компонента та порівняння close() і cancel()