组件ThreadPool::cancel()

ThreadPool::cancel() ​

(PHP 8.6+, True Async 1.0)

php
public ThreadPool::cancel(): void

发起池的强制关闭。调用 cancel() 后：

  • 任何后续的 submit() 调用都会立即抛出 Async\ThreadPoolException。
  • 在队列中等待的任务（尚未被 worker 拿走）会立即被拒绝 —— 对应的 Future 进入拒绝状态， 携带 ThreadPoolException（在 coroutine: true 模式下携带 CancellationException）。
  • 在普通模式（coroutine: false）下，已在 worker 中执行的任务会运行至当前任务结束 —— 无法强制打断 OS 线程内运行的 PHP 代码。
  • 在 coroutine: true 模式下，正在进行中的任务会被真正取消（自 TrueAsync 0.7.0 起）： 原子标志 cancel_requested 在 channel 关闭前置位，worker 调用 ZEND_ASYNC_SCOPE_CANCEL(pool_scope, NULL, false, false)，AFTER_MAIN 把所有正在跑的任务的 子 scope 级联取消。
  • worker 在当前任务结束后立即停止，不再从队列中拉取新任务。

如果想要优雅关闭并让队列中的任务跑完，请使用 close()。

返回值 ​

void

示例 ​

示例 #1 有排队任务时执行强制取消 ​

php
<?php

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

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

    // 跨 2 个工作线程填满 8 个任务
    $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  (仍在队列中)
});

参见 ​