Merge pull request #158 from clue-labs/exception

WyriHaximus · web-flow · commit 1fb6a4b4998a · 2018-03-26T16:49:44.000+02:00
Allow throwing Exception if stream resource is not supported
diff --git a/README.md b/README.md
@@ -499,7 +499,8 @@ checking whether it is ready to read by this loop implementation.
 A single stream resource MUST NOT be added more than once.
 Instead, either call [`removeReadStream()`](#removereadstream) first or
 react to this event with a single listener and then dispatch from this
-listener.
+listener. This method MAY throw an `Exception` if the given resource type
+is not supported by this loop implementation.
 
 The listener callback function MUST be able to accept a single parameter,
 the stream resource added by this method or you MAY use a function which
@@ -550,7 +551,8 @@ checking whether it is ready to write by this loop implementation.
 A single stream resource MUST NOT be added more than once.
 Instead, either call [`removeWriteStream()`](#removewritestream) first or
 react to this event with a single listener and then dispatch from this
-listener.
+listener. This method MAY throw an `Exception` if the given resource type
+is not supported by this loop implementation.
 
 The listener callback function MUST be able to accept a single parameter,
 the stream resource added by this method or you MAY use a function which
diff --git a/src/LoopInterface.php b/src/LoopInterface.php
@@ -17,7 +17,8 @@ interface LoopInterface
      * A single stream resource MUST NOT be added more than once.
      * Instead, either call [`removeReadStream()`](#removereadstream) first or
      * react to this event with a single listener and then dispatch from this
-     * listener.
+     * listener. This method MAY throw an `Exception` if the given resource type
+     * is not supported by this loop implementation.
      *
      * The listener callback function MUST be able to accept a single parameter,
      * the stream resource added by this method or you MAY use a function which
@@ -47,6 +48,7 @@ interface LoopInterface
      *
      * @param resource $stream   The PHP stream resource to check.
      * @param callable $listener Invoked when the stream is ready.
+     * @throws \Exception if the given resource type is not supported by this loop implementation
      * @see self::removeReadStream()
      */
     public function addReadStream($stream, $listener);
@@ -64,7 +66,8 @@ public function addReadStream($stream, $listener);
      * A single stream resource MUST NOT be added more than once.
      * Instead, either call [`removeWriteStream()`](#removewritestream) first or
      * react to this event with a single listener and then dispatch from this
-     * listener.
+     * listener. This method MAY throw an `Exception` if the given resource type
+     * is not supported by this loop implementation.
      *
      * The listener callback function MUST be able to accept a single parameter,
      * the stream resource added by this method or you MAY use a function which
@@ -102,6 +105,7 @@ public function addReadStream($stream, $listener);
      *
      * @param resource $stream   The PHP stream resource to check.
      * @param callable $listener Invoked when the stream is ready.
+     * @throws \Exception if the given resource type is not supported by this loop implementation
      * @see self::removeWriteStream()
      */
     public function addWriteStream($stream, $listener);
