Documentation for removing stream listeners

reactphp · Oct 13, 2017 · 3a7ad74 · 3a7ad74
1 parent 8997565
commit 3a7ad74
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -358,16 +358,25 @@ the same time is not guaranteed.
 The `removeReadStream(resource $stream): void` method can be used to
 remove the read event listener for the given stream.
 
+Removing a stream from the loop that has already been removed or trying
+to remove a stream that was never added or is invalid has no effect.
+
 ### removeWriteStream()
 
 The `removeWriteStream(resource $stream): void` method can be used to
 remove the write event listener for the given stream.
 
+Removing a stream from the loop that has already been removed or trying
+to remove a stream that was never added or is invalid has no effect.
+
 ### removeStream()
 
 The `removeStream(resource $stream): void` method can be used to
 remove all listeners for the given stream.
 
+Removing a stream from the loop that has already been removed or trying
+to remove a stream that was never added or is invalid has no effect.
+
 ## Install
 
 The recommended way to install this library is [through Composer](http://getcomposer.org).

diff --git a/src/LoopInterface.php b/src/LoopInterface.php
@@ -77,20 +77,29 @@ public function addWriteStream($stream, callable $listener);
     /**
      * Remove the read event listener for the given stream.
      *
+     * Removing a stream from the loop that has already been removed or trying
+     * to remove a stream that was never added or is invalid has no effect.
+     *
      * @param resource $stream The PHP stream resource.
      */
     public function removeReadStream($stream);
 
     /**
      * Remove the write event listener for the given stream.
      *
+     * Removing a stream from the loop that has already been removed or trying
+     * to remove a stream that was never added or is invalid has no effect.
+     *
      * @param resource $stream The PHP stream resource.
      */
     public function removeWriteStream($stream);
 
     /**
      * Remove all listeners for the given stream.
      *
+     * Removing a stream from the loop that has already been removed or trying
+     * to remove a stream that was never added or is invalid has no effect.
+     *
      * @param resource $stream The PHP stream resource.
      */
     public function removeStream($stream);