danog/amp
1
0
Fork 0
mirror of https://github.com/danog/amp.git synced 2024-11-30 04:29:08 +01:00
Code Issues Projects Releases Wiki Activity

Allow referencing a TimeoutCancellation

Browse Source
This commit is contained in:
Daniil Gentili 2023-07-25 14:23:00 +02:00
parent 6f1da17ac5
commit c6bf4c5023
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
2 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/TimeoutCancellation.php
View File

@ -17,10 +17,11 @@ final class TimeoutCancellation implements Cancellation
private readonly Cancellation $cancellation; private readonly Cancellation $cancellation;
/** /**
* @param float $timeout Seconds until cancellation is requested. * @param float $timeout Seconds until cancellation is requested.
* @param string $message Message for TimeoutException. Default is "Operation timed out". * @param string $message Message for TimeoutException. Default is "Operation timed out".
* @param bool $unreference Whether to unreference the timer.
*/ */
public function __construct(float $timeout, string $message = "Operation timed out") public function __construct(float $timeout, string $message = "Operation timed out", bool $unreference = true)
{ {
$this->cancellation = $source = new Internal\Cancellable; $this->cancellation = $source = new Internal\Cancellable;
@ -37,7 +38,9 @@ final class TimeoutCancellation implements Cancellation
$source->cancel(new TimeoutException($message)); $source->cancel(new TimeoutException($message));
}); });
EventLoop::unreference($this->watcher); if ($unreference) {
EventLoop::unreference($this->watcher);
}
} }
/** /**

17
test/Cancellation/TimeoutCancellationTest.php
View File

@ -3,6 +3,7 @@
namespace Amp\Cancellation; namespace Amp\Cancellation;
use Amp\CancelledException; use Amp\CancelledException;
use Amp\DeferredFuture;
use Amp\TestCase; use Amp\TestCase;
use Amp\TimeoutCancellation; use Amp\TimeoutCancellation;
use Amp\TimeoutException; use Amp\TimeoutException;
@ -42,4 +43,20 @@ class TimeoutCancellationTest extends TestCase
unset($cancellation); unset($cancellation);
self::assertSame($identifiers, EventLoop::getIdentifiers()); self::assertSame($identifiers, EventLoop::getIdentifiers());
} }
public function testWatcherUnreference(): void
{
$this->expectExceptionMessageMatches("/Event loop terminated without resuming the current suspension/");
$deferred = new DeferredFuture;
$cancellation = new TimeoutCancellation(0.001);
$deferred->getFuture()->await($cancellation);
}
public function testWatcherNoUnreference(): void
{
$this->expectException(CancelledException::class);
$cancellation = new TimeoutCancellation(0.001, unreference: false);
$deferred = new DeferredFuture;
$deferred->getFuture()->await($cancellation);
}
} }