Документация

Узнайте, как использовать TrueAsync для создания конкурентных PHP-приложений.

await

(PHP 8.6+, True Async 1.0)

await() — Ожидает завершения корутины, Async\Future или любого другого Async\Completable. Возвращает результат или выбрасывает исключение.

Описание

await(Async\Completable $awaitable, ?Async\Completable $cancellation = null): mixed

Приостанавливает выполнение текущей корутины до завершения указанного Async\Completable $awaitable (или до наступления $cancellation, если он указан) и возвращает результат. Если awaitable уже завершён, результат возвращается немедленно.

Если корутина завершилась с исключением, оно будет пробрасываться вызывающему коду.

Параметры

awaitable Объект, реализующий интерфейс Async\Completable (расширяет Async\Awaitable). Обычно это:

cancellation Опциональный объект Async\Completable, при выполнении которого ожидание будет отменено.

Возвращаемое значение

Возвращает значение, которое вернула корутина. Тип возвращаемого значения зависит от корутины.

Ошибки/Исключения

Если корутина завершилась с исключением, await() пробросит это исключение.

Если корутина была отменена, будет выброшено Async\CancellationException.

Примеры

Пример #1 Базовое использование await()

<?php
use function Async\spawn;
use function Async\await;

$coroutine = spawn(function() {
    return "Hello, Async!";
});

echo await($coroutine); // Hello, Async!
?>

Пример #2 Последовательное ожидание

<?php
use function Async\spawn;
use function Async\await;

function fetchUser(int $id): array {
    return json_decode(
        file_get_contents("https://api/users/$id"),
        true
    );
}

function fetchPosts(int $userId): array {
    return json_decode(
        file_get_contents("https://api/posts?user=$userId"),
        true
    );
}

$userCoro = spawn(fetchUser(...), 123);
$user = await($userCoro);

$postsCoro = spawn(fetchPosts(...), $user['id']);
$posts = await($postsCoro);

echo "Пользователь: {$user['name']}\n";
echo "Постов: " . count($posts) . "\n";
?>

Пример #3 Обработка исключений

<?php
use function Async\spawn;
use function Async\await;

$coroutine = spawn(function() {
    $response = file_get_contents('https://api.com/data');

    if ($response === false) {
        throw new RuntimeException("Не удалось загрузить данные");
    }

    return $response;
});

try {
    $data = await($coroutine);
    echo "Данные получены\n";
} catch (RuntimeException $e) {
    echo "Ошибка: " . $e->getMessage() . "\n";
}
?>

Пример #4 await с TaskGroup

<?php
use function Async\spawn;
use function Async\await;
use Async\TaskGroup;

$taskGroup = new TaskGroup();

$taskGroup->spawn(function() {
    return "Результат 1";
});

$taskGroup->spawn(function() {
    return "Результат 2";
});

$taskGroup->spawn(function() {
    return "Результат 3";
});

// Получаем массив всех результатов
$results = await($taskGroup);
print_r($results); // Массив результатов
?>

Пример #5 Множественные await на одной корутине

<?php
use function Async\spawn;
use function Async\await;

$coroutine = spawn(function() {
    Async\timeout(1000);
    return "Готово";
});

// Первый await дождётся результата
$result1 = await($coroutine);
echo "$result1\n";

// Последующие await вернут результат мгновенно
$result2 = await($coroutine);
echo "$result2\n";

var_dump($result1 === $result2); // true
?>

Пример #6 await внутри корутины

<?php
use function Async\spawn;
use function Async\await;

spawn(function() {
    echo "Родительская корутина запущена\n";

    $child = spawn(function() {
        echo "Дочерняя корутина работает\n";
        Async\sleep(1000);
        return "Результат от дочерней";
    });

    echo "Ожидаем дочернюю...\n";
    $result = await($child);
    echo "Получили: $result\n";
});

echo "Основной код продолжается\n";
?>

Changelog

Версия Описание
1.0.0 Добавлена функция await()

См. также