Merge pull request #309 from clue-labs/template-types

WyriHaximus · web-flow · commit 41580db51aa7 · 2023-08-07T15:39:03.000+02:00
Use Promise v3 template types
diff --git a/README.md b/README.md
@@ -860,8 +860,8 @@ The interface only offers a single method:
 
 #### connect()
 
-The `connect(string $uri): PromiseInterface<ConnectionInterface,Exception>` method
-can be used to create a streaming connection to the given remote address.
+The `connect(string $uri): PromiseInterface<ConnectionInterface>` method can be used to
+create a streaming connection to the given remote address.
 
 It returns a [Promise](https://github.com/reactphp/promise) which either
 fulfills with a stream implementing [`ConnectionInterface`](#connectioninterface)
diff --git a/composer.json b/composer.json
@@ -37,7 +37,7 @@
         "phpunit/phpunit": "^9.5 || ^5.7 || ^4.8.35",
         "react/async": "^4 || ^3 || ^2",
         "react/promise-stream": "^1.4",
-        "react/promise-timer": "^1.9"
+        "react/promise-timer": "^1.10"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/ConnectorInterface.php b/src/ConnectorInterface.php
@@ -51,7 +51,8 @@ interface ConnectorInterface
      * ```
      *
      * @param string $uri
-     * @return \React\Promise\PromiseInterface resolves with a stream implementing ConnectionInterface on success or rejects with an Exception on error
+     * @return \React\Promise\PromiseInterface<ConnectionInterface>
+     *     Resolves with a `ConnectionInterface` on success or rejects with an `Exception` on error.
      * @see ConnectionInterface
      */
     public function connect($uri);
diff --git a/src/SecureConnector.php b/src/SecureConnector.php
@@ -43,7 +43,7 @@ public function connect($uri)
         $context = $this->context;
         $encryption = $this->streamEncryption;
         $connected = false;
-        /** @var \React\Promise\PromiseInterface $promise */
+        /** @var \React\Promise\PromiseInterface<ConnectionInterface> $promise */
         $promise = $this->connector->connect(
             \str_replace('tls://', '', $uri)
         )->then(function (ConnectionInterface $connection) use ($context, $encryption, $uri, &$promise, &$connected) {
diff --git a/src/StreamEncryption.php b/src/StreamEncryption.php
@@ -44,11 +44,20 @@ public function __construct(LoopInterface $loop, $server = true)
         }
     }
 
+    /**
+     * @param Connection $stream
+     * @return \React\Promise\PromiseInterface<Connection>
+     */
     public function enable(Connection $stream)
     {
         return $this->toggle($stream, true);
     }
 
+    /**
+     * @param Connection $stream
+     * @param bool $toggle
+     * @return \React\Promise\PromiseInterface<Connection>
+     */
     public function toggle(Connection $stream, $toggle)
     {
         // pause actual stream instance to continue operation on raw stream socket
@@ -98,6 +107,14 @@ public function toggle(Connection $stream, $toggle)
         });
     }
 
+    /**
+     * @internal
+     * @param resource $socket
+     * @param Deferred<null> $deferred
+     * @param bool $toggle
+     * @param int $method
+     * @return void
+     */
     public function toggleCrypto($socket, Deferred $deferred, $toggle, $method)
     {
         $error = null;

Original file line number	Diff line number	Diff line change
`@@ -44,11 +44,20 @@ public function __construct(LoopInterface $loop, $server = true)`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
	`47`	`+ /**`
	`48`	`+ * @param Connection $stream`
	`49`	`+ * @return \React\Promise\PromiseInterface<Connection>`
	`50`	`+ */`
`47`	`51`	`public function enable(Connection $stream)`
`48`	`52`	`{`
`49`	`53`	`return $this->toggle($stream, true);`
`50`	`54`	`}`
`51`	`55`
	`56`	`+ /**`
	`57`	`+ * @param Connection $stream`
	`58`	`+ * @param bool $toggle`
	`59`	`+ * @return \React\Promise\PromiseInterface<Connection>`
	`60`	`+ */`
`52`	`61`	`public function toggle(Connection $stream, $toggle)`
`53`	`62`	`{`
`54`	`63`	`// pause actual stream instance to continue operation on raw stream socket`
`@@ -98,6 +107,14 @@ public function toggle(Connection $stream, $toggle)`
`98`	`107`	`});`
`99`	`108`	`}`
`100`	`109`
	`110`	`+ /**`
	`111`	`+ * @internal`
	`112`	`+ * @param resource $socket`
	`113`	`+ * @param Deferred<null> $deferred`
	`114`	`+ * @param bool $toggle`
	`115`	`+ * @param int $method`
	`116`	`+ * @return void`
	`117`	`+ */`
`101`	`118`	`public function toggleCrypto($socket, Deferred $deferred, $toggle, $method)`
`102`	`119`	`{`
`103`	`120`	`$error = null;`