组件Scope::dispose

Scope::dispose ​

(PHP 8.6+, True Async 1.0)

php
public function dispose(): void

关闭作用域并取消其中的所有协程。调用 dispose() 后，作用域将被标记为已关闭和已取消。无法向已关闭的作用域添加新的协程。

对于没有 dispose-safely 标志的作用域（new Scope() 默认如此），这等同于先调用 cancel() 再关闭作用域。带有该标志的作用域——通过 allowZombies() 开启，或从带有该标志的父级继承而来，比如全局作用域——不会取消协程，而是让它们作为僵尸继续运行，就像 disposeSafely() 一样。

返回值 ​

没有返回值。

示例 ​

示例 #1 强制关闭作用域 ​

php
<?php

use Async\Scope;

$scope = new Scope();

$scope->spawn(function() {
    try {
        \Async\delay(60_000);
    } catch (\Async\AsyncCancellation) {
        echo "Coroutine cancelled on dispose\n";
    }
});

// All coroutines will be cancelled, scope closed
$scope->dispose();

var_dump($scope->isClosed());    // bool(true)
var_dump($scope->isCancelled()); // bool(true)

示例 #2 在 try/finally 块中清理 ​

php
<?php

use Async\Scope;

$scope = new Scope();

try {
    $scope->spawn(function() {
        // Business logic
        \Async\delay(5000);
    });

    $scope->awaitCompletion(Async\timeout(5000));
} finally {
    $scope->dispose();
}

参见 ​