Annotate CancelledException correctly

amphp · May 30, 2019 · 864fea2 · 864fea2
1 parent 3c136d2
commit 864fea2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/src/Connector.php b/src/Connector.php
@@ -3,6 +3,7 @@
 namespace Amp\Socket;
 
 use Amp\CancellationToken;
+use Amp\CancelledException;
 use Amp\Promise;
 
 interface Connector
@@ -17,6 +18,7 @@ interface Connector
      * @return Promise<EncryptableSocket>
      *
      * @throws ConnectException
+     * @throws CancelledException
      */
     public function connect(
         string $uri,

diff --git a/src/SocketPool.php b/src/SocketPool.php
@@ -3,6 +3,7 @@
 namespace Amp\Socket;
 
 use Amp\CancellationToken;
+use Amp\CancelledException;
 use Amp\Promise;
 
 /**
@@ -28,6 +29,7 @@ interface SocketPool
      * @return Promise<EncryptableSocket> Resolves to an EncryptableSocket instance once a connection is available.
      *
      * @throws SocketException
+     * @throws CancelledException
      */
     public function checkout(
         string $uri,

diff --git a/src/functions.php b/src/functions.php
@@ -3,6 +3,7 @@
 namespace Amp\Socket;
 
 use Amp\CancellationToken;
+use Amp\CancelledException;
 use Amp\Loop;
 use Amp\Promise;
 
@@ -112,6 +113,7 @@ function connector(Connector $connector = null): Connector
  * @return Promise<EncryptableSocket>
  *
  * @throws ConnectException
+ * @throws CancelledException
  */
 function connect(string $uri, ConnectContext $context = null, CancellationToken $token = null): Promise
 {