Merge pull request #62 from clue-labs/close

clue · web-flow · commit f1e457df0db7 · 2017-01-27T11:43:52.000+01:00
Rename shutdown() to close() for consistency throughout React
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ and [`Stream`](https://github.com/reactphp/stream) components.
     * [error event](#error-event)
     * [listen()](#listen)
     * [getPort()](#getport)
-    * [shutdown()](#shutdown)
+    * [close()](#close)
   * [Server](#server)
   * [SecureServer](#secureserver)
   * [ConnectionInterface](#connectioninterface)
@@ -146,22 +146,22 @@ echo 'Server listening on port ' . $port . PHP_EOL;
 ```
 
 This method MUST NOT be called before calling [`listen()`](#listen).
-This method MUST NOT be called after calling [`shutdown()`](#shutdown).
+This method MUST NOT be called after calling [`close()`](#close).
 
-#### shutdown()
+#### close()
 
-The `shutdown(): void` method can be used to
+The `close(): void` method can be used to
 shut down this listening socket.
 
 This will stop listening for new incoming connections on this socket.
 
 ```php
 echo 'Shutting down server socket' . PHP_EOL;
-$server->shutdown();
+$server->close();
 ```
 
 This method MUST NOT be called before calling [`listen()`](#listen).
-This method MUST NOT be called after calling [`shutdown()`](#shutdown).
+This method MUST NOT be called after calling [`close()`](#close).
 
 ### Server
 
diff --git a/src/SecureServer.php b/src/SecureServer.php
@@ -78,9 +78,9 @@ public function getPort()
         return $this->tcp->getPort();
     }
 
-    public function shutdown()
+    public function close()
     {
-        return $this->tcp->shutdown();
+        return $this->tcp->close();
     }
 
     /** @internal */
diff --git a/src/Server.php b/src/Server.php
@@ -120,7 +120,7 @@ public function getPort()
         return (int) substr(strrchr($name, ':'), 1);
     }
 
-    public function shutdown()
+    public function close()
     {
         $this->loop->removeStream($this->master);
         fclose($this->master);
diff --git a/src/ServerInterface.php b/src/ServerInterface.php
@@ -72,7 +72,7 @@ public function listen($port, $host = '127.0.0.1');
      * Returns the port this server is currently listening on
      *
      * This method MUST NOT be called before calling listen().
-     * This method MUST NOT be called after calling shutdown().
+     * This method MUST NOT be called after calling close().
      *
      * @return int the port number
      */
@@ -84,9 +84,9 @@ public function getPort();
      * This will stop listening for new incoming connections on this socket.
      *
      * This method MUST NOT be called before calling listen().
-     * This method MUST NOT be called after calling shutdown().
+     * This method MUST NOT be called after calling close().
      *
      * @return void
      */
-    public function shutdown();
+    public function close();
 }
diff --git a/tests/SecureServerTest.php b/tests/SecureServerTest.php
@@ -25,15 +25,15 @@ public function testGetPortWillBePassedThroughToTcpServer()
         $this->assertEquals(1234, $server->getPort());
     }
 
-    public function testShutdownWillBePassedThroughToTcpServer()
+    public function testCloseWillBePassedThroughToTcpServer()
     {
         $tcp = $this->getMockBuilder('React\Socket\Server')->disableOriginalConstructor()->getMock();
-        $tcp->expects($this->once())->method('shutdown');
+        $tcp->expects($this->once())->method('close');
 
         $loop = $this->getMock('React\EventLoop\LoopInterface');
 
         $server = new SecureServer($tcp, $loop, array());
 
-        $server->shutdown();
+        $server->close();
     }
 }
diff --git a/tests/ServerTest.php b/tests/ServerTest.php
@@ -132,27 +132,27 @@ public function testDataWillBeFragmentedToBufferSize()
         $this->loop->tick();
     }
 
-    public function testLoopWillEndWhenServerIsShutDown()
+    public function testLoopWillEndWhenServerIsClosed()
     {
-        // explicitly unset server because we already call shutdown()
-        $this->server->shutdown();
+        // explicitly unset server because we already call close()
+        $this->server->close();
         $this->server = null;
 
         $this->loop->run();
     }
 
-    public function testLoopWillEndWhenServerIsShutDownAfterSingleConnection()
+    public function testLoopWillEndWhenServerIsClosedAfterSingleConnection()
     {
         $client = stream_socket_client('tcp://localhost:' . $this->port);
 
         // explicitly unset server because we only accept a single connection
-        // and then already call shutdown()
+        // and then already call close()
         $server = $this->server;
         $this->server = null;
 
         $server->on('connection', function ($conn) use ($server) {
             $conn->close();
-            $server->shutdown();
+            $server->close();
         });
 
         $this->loop->run();
@@ -169,7 +169,7 @@ public function testDataWillBeEmittedInMultipleChunksWhenClientSendsExcessiveAmo
         $mock = $this->expectCallableOnce();
 
         // explicitly unset server because we only accept a single connection
-        // and then already call shutdown()
+        // and then already call close()
         $server = $this->server;
         $this->server = null;
 
@@ -183,7 +183,7 @@ public function testDataWillBeEmittedInMultipleChunksWhenClientSendsExcessiveAmo
             $conn->on('end', $mock);
 
             // do not await any further connections in order to let the loop terminate
-            $server->shutdown();
+            $server->close();
         });
 
         $this->loop->run();
@@ -236,12 +236,12 @@ public function testListenOnBusyPortThrows()
     }
 
     /**
-     * @covers React\Socket\Server::shutdown
+     * @covers React\Socket\Server::close
      */
     public function tearDown()
     {
         if ($this->server) {
-            $this->server->shutdown();
+            $this->server->close();
         }
     }
 }
diff --git a/tests/Stub/ServerStub.php b/tests/Stub/ServerStub.php
@@ -16,7 +16,7 @@ public function getPort()
         return 80;
     }
 
-    public function shutdown()
+    public function close()
     {
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -78,9 +78,9 @@ public function getPort()`
`78`	`78`	`return $this->tcp->getPort();`
`79`	`79`	`}`
`80`	`80`
`81`		`- public function shutdown()`
	`81`	`+ public function close()`
`82`	`82`	`{`
`83`		`- return $this->tcp->shutdown();`
	`83`	`+ return $this->tcp->close();`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`/** @internal */`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ public function getPort()`
`120`	`120`	`return (int) substr(strrchr($name, ':'), 1);`
`121`	`121`	`}`
`122`	`122`
`123`		`- public function shutdown()`
	`123`	`+ public function close()`
`124`	`124`	`{`
`125`	`125`	`$this->loop->removeStream($this->master);`
`126`	`126`	`fclose($this->master);`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function listen($port, $host = '127.0.0.1');`
`72`	`72`	`* Returns the port this server is currently listening on`
`73`	`73`	`*`
`74`	`74`	`* This method MUST NOT be called before calling listen().`
`75`		`- * This method MUST NOT be called after calling shutdown().`
	`75`	`+ * This method MUST NOT be called after calling close().`
`76`	`76`	`*`
`77`	`77`	`* @return int the port number`
`78`	`78`	`*/`
`@@ -84,9 +84,9 @@ public function getPort();`
`84`	`84`	`* This will stop listening for new incoming connections on this socket.`
`85`	`85`	`*`
`86`	`86`	`* This method MUST NOT be called before calling listen().`
`87`		`- * This method MUST NOT be called after calling shutdown().`
	`87`	`+ * This method MUST NOT be called after calling close().`
`88`	`88`	`*`
`89`	`89`	`* @return void`
`90`	`90`	`*/`
`91`		`- public function shutdown();`
	`91`	`+ public function close();`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,15 +25,15 @@ public function testGetPortWillBePassedThroughToTcpServer()`
`25`	`25`	`$this->assertEquals(1234, $server->getPort());`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function testShutdownWillBePassedThroughToTcpServer()`
	`28`	`+ public function testCloseWillBePassedThroughToTcpServer()`
`29`	`29`	`{`
`30`	`30`	`$tcp = $this->getMockBuilder('React\Socket\Server')->disableOriginalConstructor()->getMock();`
`31`		`- $tcp->expects($this->once())->method('shutdown');`
	`31`	`+ $tcp->expects($this->once())->method('close');`
`32`	`32`
`33`	`33`	`$loop = $this->getMock('React\EventLoop\LoopInterface');`
`34`	`34`
`35`	`35`	`$server = new SecureServer($tcp, $loop, array());`
`36`	`36`
`37`		`- $server->shutdown();`
	`37`	`+ $server->close();`
`38`	`38`	`}`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public function getPort()`
`16`	`16`	`return 80;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public function shutdown()`
	`19`	`+ public function close()`
`20`	`20`	`{`
`21`	`21`	`}`
`22`	`22`	`}`