1
0
mirror of https://github.com/danog/amp.git synced 2024-12-13 09:57:25 +01:00
amp/lib/TimeoutCancellationToken.php

76 lines
1.8 KiB
PHP
Raw Normal View History

2017-06-13 19:41:47 +02:00
<?php
namespace Amp;
use function Amp\Internal\formatStacktrace;
2017-06-13 19:41:47 +02:00
/**
* A TimeoutCancellationToken automatically requests cancellation after the timeout has elapsed.
*/
2018-06-18 20:00:01 +02:00
final class TimeoutCancellationToken implements CancellationToken
{
2017-06-13 19:41:47 +02:00
/** @var string */
private $watcher;
/** @var CancellationToken */
2017-06-13 19:41:47 +02:00
private $token;
/**
* @param int $timeout Milliseconds until cancellation is requested.
* @param string $message Message for TimeoutException. Default is "Operation timed out".
2017-06-13 19:41:47 +02:00
*/
public function __construct(int $timeout, string $message = "Operation timed out")
2018-06-18 20:00:01 +02:00
{
2017-06-13 19:41:47 +02:00
$source = new CancellationTokenSource;
$this->token = $source->getToken();
$trace = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
$this->watcher = Loop::delay($timeout, static function () use ($source, $message, $trace) {
$trace = formatStacktrace($trace);
$source->cancel(new TimeoutException("$message\r\nTimeoutCancellationToken was created here:\r\n$trace"));
2017-06-13 19:41:47 +02:00
});
2017-06-13 19:41:47 +02:00
Loop::unreference($this->watcher);
}
/**
* Cancels the delay watcher.
*/
2018-06-18 20:00:01 +02:00
public function __destruct()
{
2017-06-13 19:41:47 +02:00
Loop::cancel($this->watcher);
}
/**
* {@inheritdoc}
*/
2018-06-18 20:00:01 +02:00
public function subscribe(callable $callback): string
{
2017-06-13 19:41:47 +02:00
return $this->token->subscribe($callback);
}
/**
* {@inheritdoc}
*/
2018-06-18 20:00:01 +02:00
public function unsubscribe(string $id)
{
2017-06-13 19:41:47 +02:00
$this->token->unsubscribe($id);
}
/**
* {@inheritdoc}
*/
2018-06-18 20:00:01 +02:00
public function isRequested(): bool
{
2017-06-13 19:41:47 +02:00
return $this->token->isRequested();
}
/**
* {@inheritdoc}
*/
2018-06-18 20:00:01 +02:00
public function throwIfRequested()
{
2017-06-13 19:41:47 +02:00
$this->token->throwIfRequested();
}
}