danog/amp
1
0
Fork 0
mirror of https://github.com/danog/amp.git synced 2024-12-03 09:57:51 +01:00
Code Issues Projects Releases Wiki Activity

Fix documentation in CancellationToken

Browse Source
This commit is contained in:
Niklas Keller 2021-12-02 21:48:13 +01:00
parent e12c20cbda
commit 2645e0fd84
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/CancellationToken.php
View File

@ -10,11 +10,11 @@ interface CancellationToken
/**
* 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 thrown into the event loop.
* This handler might be invoked immediately in case the token has already been cancelled. Any unhandled exceptions
* will be thrown into the event loop.
*
* @param \Closure(CancelledException) $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.
* `CancelledException` as first argument that may be used to fail the operation.
*
* @return string Identifier that can be used to cancel the subscription.
*/