timeout

(PHP 8.6+, True Async 1.0)

timeout() — Створює об’єкт Async\Timeout, який спрацьовує через вказану кількість мілісекунд.

Опис

timeout(int $ms): Async\Awaitable

Створює таймер, який викидає Async\TimeoutException через $ms мілісекунд. Використовується як обмежувач часу очікування в await() та інших функціях.

Параметри

ms Час у мілісекундах. Має бути більше 0.

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

Повертає об’єкт Async\Timeout, що реалізує Async\Completable.

Помилки/Винятки

Приклади

Приклад #1 Тайм-аут для await()

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

$coroutine = spawn(function() {
    return file_get_contents('https://slow-api.example.com');
});

try {
    $result = await($coroutine, timeout(3000));
} catch (TimeoutException $e) {
    echo "Запит не завершився за 3 секунди\n";
}
?>

Приклад #2 Тайм-аут для групи задач

<?php
use function Async\spawn;
use function Async\await_all_or_fail;
use function Async\timeout;

try {
    $results = await_all_or_fail([
        spawn(file_get_contents(...), 'https://api/a'),
        spawn(file_get_contents(...), 'https://api/b'),
    ], timeout(5000));
} catch (Async\TimeoutException $e) {
    echo "Не всі запити завершилися за 5 секунд\n";
}
?>

Приклад #3 Скасування тайм-ауту

<?php
use function Async\timeout;

$timer = timeout(5000);

// Операція завершилася швидше — скасовуємо таймер
$timer->cancel();
?>

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