Coroutine::getException

(PHP 8.6+, True Async 1.0)

public Coroutine::getException(): mixed

返回协程中发生的异常。如果协程成功完成或尚未完成,则返回 null。如果协程被取消,则返回 AsyncCancellation 对象。

返回值

mixed – 异常或 null

错误

如果协程当前正在运行,则抛出 RuntimeException

示例

示例 #1 成功完成

<?php

use function Async\spawn;
use function Async\await;

$coroutine = spawn(function() {
    return "success";
});

await($coroutine);
var_dump($coroutine->getException()); // NULL

示例 #2 异常完成

<?php

use function Async\spawn;
use function Async\await;

$coroutine = spawn(function() {
    throw new RuntimeException("test error");
});

try {
    await($coroutine);
} catch (RuntimeException $e) {
    // 在 await 期间捕获
}

$exception = $coroutine->getException();
var_dump($exception instanceof RuntimeException); // bool(true)
var_dump($exception->getMessage());                // string(10) "test error"

示例 #3 已取消的协程

<?php

use function Async\spawn;
use function Async\suspend;

$coroutine = spawn(function() {
    Async\delay(10000);
});

suspend();
$coroutine->cancel();
suspend();

$exception = $coroutine->getException();
var_dump($exception instanceof \Async\AsyncCancellation); // bool(true)

参见