Scope::cancel

(PHP 8.6+, True Async 1.0)

public function cancel(?AsyncCancellation $cancellationError = null): void

Annule toutes les coroutines appartenant au scope donné. Chaque coroutine active recevra une CancelledException. Si $cancellationError est spécifié, il sera utilisé comme raison de l’annulation.

Paramètres

cancellationError — une exception d’annulation personnalisée. Si null, la CancelledException standard est utilisée.

Valeur de retour

Aucune valeur n’est retournée.

Exemples

Exemple #1 Annulation basique

<?php

use Async\Scope;

$scope = new Scope();

$scope->spawn(function() {
    try {
        \Async\delay(60_000); // Opération longue
    } catch (\Async\CancelledException $e) {
        echo "Coroutine cancelled\n";
    }
});

// Annuler toutes les coroutines
$scope->cancel();

Exemple #2 Annulation avec une erreur personnalisée

<?php

use Async\Scope;
use Async\AsyncCancellation;

$scope = new Scope();

$scope->spawn(function() {
    try {
        \Async\delay(60_000);
    } catch (\Async\CancelledException $e) {
        echo "Reason: " . $e->getMessage() . "\n";
    }
});

$error = new AsyncCancellation("Timeout exceeded");
$scope->cancel($error);

Voir aussi