Amp\CancellationToken interface CancellationToken

Cancellation tokens are simple objects that allow registering handlers to subscribe to cancellation requests.

Summary

Properties

Methods

Methods

subscribe — public function subscribe(callable $callback): string

Subscribes a new handler to be invoked on a cancellation request.

This handler might be invoked immediately in case the token has already been cancelled. Returned generators will automatically be run as coroutines. Any unhandled exceptions will be throw into the event loop.

Type Parameter Description Default Value
callable $callback Callback to be invoked on a cancellation request. Will receive a `CancelledException` as first argument that may be used to fail the operation's promise. none
unsubscribe — public function unsubscribe(string $id): void

Unsubscribes a previously registered handler.

The handler will no longer be called as long as this method isn't invoked from a subscribed callback.

Type Parameter Description Default Value
string $id No documentation. none
isRequested — public function isRequested(): bool

Returns whether cancellation has been requested yet.

throwIfRequested — public function throwIfRequested(): void

Throws the CancelledException if cancellation has been requested, otherwise does nothing.