Rename AccoutingServer to LimitingServer to avoid confusion

Author: clue

README.md

@@ -21,7 +21,7 @@ and [`Stream`](https://github.com/reactphp/stream) components.
     * [close()](#close)
   * [Server](#server)
   * [SecureServer](#secureserver)
-  * [AccountingServer](#accountingserver)
+  * [LimitingServer](#limitingserver)
     * [getConnections()](#getconnections)
   * [ConnectionInterface](#connectioninterface)
     * [getRemoteAddress()](#getremoteaddress)
@@ -380,20 +380,23 @@ If you use a custom `ServerInterface` and its `connection` event does not
 meet this requirement, the `SecureServer` will emit an `error` event and
 then close the underlying connection.
 
-### AccountingServer
+### LimitingServer
 
-The `AccountingServer` decorators wraps a given `ServerInterface` and is responsible
-for keeping track of open connections to this server instance.
+The `LimitingServer` decorator wraps a given `ServerInterface` and is responsible
+for limiting and keeping track of open connections to this server instance.
 
-Whenever the underlying server emits a `connection` event, it will keep track
-of this connection by adding it to the list of open connections and then
-forward the `connection` event (unless its limits are exceeded).
+Whenever the underlying server emits a `connection` event, it will check its
+limits and then either
+ - keep track of this connection by adding it to the list of
+   open connections and then forward the `connection` event
+ - or reject (close) the connection when its limits are exceeded and will
+   forward an `error` event instead.
 
 Whenever a connection closes, it will remove this connection from the list of
 open connections.
 
 ```php
-$server = new AccountingServer($server);
+$server = new LimitingServer($server, 100);
 $server->on('connection', function (ConnectionInterface $connection) {
     $connection->write('hello there!' . PHP_EOL);
     …
@@ -402,19 +405,25 @@ $server->on('connection', function (ConnectionInterface $connection) {
 
 See also the [second example](examples) for more details.
 
-You can optionally pass a maximum number of open connections to ensure
+You have to pass a maximum number of open connections to ensure
 the server will automatically reject (close) connections once this limit
 is exceeded. In this case, it will emit an `error` event to inform about
 this and no `connection` event will be emitted.
 
 ```php
-$server = new AccountingServer($server, 50);
+$server = new LimitingServer($server, 100);
 $server->on('connection', function (ConnectionInterface $connection) {
     $connection->write('hello there!' . PHP_EOL);
     …
 });
 ```
 
+You MAY pass a `null` limit in order to put no limit on the number of
+open connections and keep accepting new connection until you run out of
+operating system resources (such as open file handles). This may be
+useful it you do not want to take care of applying a limit but still want
+to use the `getConnections()` method.
+
 You can optionally configure the server to pause accepting new
 connections once the connection limit is reached. In this case, it will
 pause the underlying server and no longer process any new connections at
@@ -431,7 +440,7 @@ protocols that demand immediate responses (such as a "welcome" message in
 an interactive chat).
 
 ```php
-$server = new AccountingServer($server, 50, true);
+$server = new LimitingServer($server, 100, true);
 $server->on('connection', function (ConnectionInterface $connection) {
     $connection->write('hello there!' . PHP_EOL);
     …

examples/02-chat-server.php

@@ -15,7 +15,7 @@
 use React\Socket\Server;
 use React\Socket\ConnectionInterface;
 use React\Socket\SecureServer;
-use React\Socket\AccountingServer;
+use React\Socket\LimitingServer;
 
 require __DIR__ . '/../vendor/autoload.php';
 
@@ -30,7 +30,7 @@
     ));
 }
 
-$server = new AccountingServer($server);
+$server = new LimitingServer($server, null);
 
 $server->on('connection', function (ConnectionInterface $client) use ($server) {
     // whenever a new message comes in

src/AccountingServer.php src/LimitingServer.phpsrc/AccountingServer.php renamed to src/LimitingServer.php

@@ -5,18 +5,21 @@
 use Evenement\EventEmitter;
 
 /**
- * The `AccountingServer` decorators wraps a given `ServerInterface` and is responsible
- * for keeping track of open connections to this server instance.
+ * The `LimitingServer` decorator wraps a given `ServerInterface` and is responsible
+ * for limiting and keeping track of open connections to this server instance.
  *
- * Whenever the underlying server emits a `connection` event, it will keep track
- * of this connection by adding it to the list of open connections and then
- * forward the `connection` event (unless its limits are exceeded).
+ * Whenever the underlying server emits a `connection` event, it will check its
+ * limits and then either
+ * - keep track of this connection by adding it to the list of
+ *   open connections and then forward the `connection` event
+ * - or reject (close) the connection when its limits are exceeded and will
+ *   forward an `error` event instead.
  *
  * Whenever a connection closes, it will remove this connection from the list of
  * open connections.
  *
  * ```php
- * $server = new AccountingServer($server);
+ * $server = new LimitingServer($server, 100);
  * $server->on('connection', function (ConnectionInterface $connection) {
  *     $connection->write('hello there!' . PHP_EOL);
  *     …
@@ -28,7 +31,7 @@
  * @see ServerInterface
  * @see ConnectionInterface
  */
-class AccountingServer extends EventEmitter implements ServerInterface
+class LimitingServer extends EventEmitter implements ServerInterface
 {
     private $connections = array();
     private $server;
@@ -39,21 +42,27 @@ class AccountingServer extends EventEmitter implements ServerInterface
     private $manuPaused = false;
 
     /**
-     * Instantiates a new AccountingServer.
+     * Instantiates a new LimitingServer.
      *
-     * You can optionally pass a maximum number of open connections to ensure
+     * You have to pass a maximum number of open connections to ensure
      * the server will automatically reject (close) connections once this limit
      * is exceeded. In this case, it will emit an `error` event to inform about
      * this and no `connection` event will be emitted.
      *
      * ```php
-     * $server = new AccountingServer($server, 50);
+     * $server = new LimitingServer($server, 100);
      * $server->on('connection', function (ConnectionInterface $connection) {
      *     $connection->write('hello there!' . PHP_EOL);
      *     …
      * });
      * ```
      *
+     * You MAY pass a `null` limit in order to put no limit on the number of
+     * open connections and keep accepting new connection until you run out of
+     * operating system resources (such as open file handles). This may be
+     * useful it you do not want to take care of applying a limit but still want
+     * to use the `getConnections()` method.
+     *
      * You can optionally configure the server to pause accepting new
      * connections once the connection limit is reached. In this case, it will
      * pause the underlying server and no longer process any new connections at
@@ -70,18 +79,18 @@ class AccountingServer extends EventEmitter implements ServerInterface
      * an interactive chat).
      *
      * ```php
-     * $server = new AccountingServer($server, 50, true);
+     * $server = new LimitingServer($server, 100, true);
      * $server->on('connection', function (ConnectionInterface $connection) {
      *     $connection->write('hello there!' . PHP_EOL);
      *     …
      * });
      * ```
      *
      * @param ServerInterface $server
-     * @param null|int        $connectionLimit
+     * @param int|null        $connectionLimit
      * @param bool            $pauseOnLimit
      */
-    public function __construct(ServerInterface $server, $connectionLimit = null, $pauseOnLimit = false)
+    public function __construct(ServerInterface $server, $connectionLimit, $pauseOnLimit = false)
     {
         $this->server = $server;
         $this->limit = $connectionLimit;

tests/AccountingServerTest.php tests/LimitingServerTest.phptests/AccountingServerTest.php renamed to tests/LimitingServerTest.php

@@ -2,25 +2,19 @@
 
 namespace React\Tests\Socket;
 
-use React\Socket\AccountingServer;
+use React\Socket\LimitingServer;
 use React\Socket\Server;
 use React\EventLoop\Factory;
 use Clue\React\Block;
 
-class AccountingServerTest extends TestCase
+class LimitingServerTest extends TestCase
 {
-    public function testA()
-    {
-        $server = $this->getMockBuilder('React\Socket\ServerInterface')->getMock();
-        $server = new AccountingServer($server);
-    }
-
     public function testGetAddressWillBePassedThroughToTcpServer()
     {
         $tcp = $this->getMockBuilder('React\Socket\ServerInterface')->getMock();
         $tcp->expects($this->once())->method('getAddress')->willReturn('127.0.0.1:1234');
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
 
         $this->assertEquals('127.0.0.1:1234', $server->getAddress());
     }
@@ -30,7 +24,7 @@ public function testPauseWillBePassedThroughToTcpServer()
         $tcp = $this->getMockBuilder('React\Socket\ServerInterface')->getMock();
         $tcp->expects($this->once())->method('pause');
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
 
         $server->pause();
     }
@@ -40,7 +34,7 @@ public function testPauseTwiceWillBePassedThroughToTcpServerOnce()
         $tcp = $this->getMockBuilder('React\Socket\ServerInterface')->getMock();
         $tcp->expects($this->once())->method('pause');
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
 
         $server->pause();
         $server->pause();
@@ -51,7 +45,7 @@ public function testResumeWillBePassedThroughToTcpServer()
         $tcp = $this->getMockBuilder('React\Socket\ServerInterface')->getMock();
         $tcp->expects($this->once())->method('resume');
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
 
         $server->pause();
         $server->resume();
@@ -62,7 +56,7 @@ public function testResumeTwiceWillBePassedThroughToTcpServerOnce()
         $tcp = $this->getMockBuilder('React\Socket\ServerInterface')->getMock();
         $tcp->expects($this->once())->method('resume');
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
 
         $server->pause();
         $server->resume();
@@ -74,7 +68,7 @@ public function testCloseWillBePassedThroughToTcpServer()
         $tcp = $this->getMockBuilder('React\Socket\ServerInterface')->getMock();
         $tcp->expects($this->once())->method('close');
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
 
         $server->close();
     }
@@ -85,7 +79,7 @@ public function testSocketErrorWillBeForwarded()
 
         $tcp = new Server(0, $loop);
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
 
         $server->on('error', $this->expectCallableOnce());
 
@@ -100,7 +94,7 @@ public function testSocketConnectionWillBeForwarded()
 
         $tcp = new Server(0, $loop);
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
         $server->on('connection', $this->expectCallableOnceWith($connection));
         $server->on('error', $this->expectCallableNever());
 
@@ -120,7 +114,7 @@ public function testSocketConnectionWillBeClosedOnceLimitIsReached()
 
         $tcp = new Server(0, $loop);
 
-        $server = new AccountingServer($tcp, 1);
+        $server = new LimitingServer($tcp, 1);
         $server->on('connection', $this->expectCallableOnceWith($first));
         $server->on('error', $this->expectCallableOnce());
 
@@ -138,7 +132,7 @@ public function testPausingServerWillBePausedOnceLimitIsReached()
 
         $connection = $this->getMockBuilder('React\Socket\ConnectionInterface')->getMock();
 
-        $server = new AccountingServer($tcp, 1, true);
+        $server = new LimitingServer($tcp, 1, true);
 
         $tcp->emit('connection', array($connection));
     }
@@ -152,7 +146,7 @@ public function testSocketDisconnectionWillRemoveFromList()
         $socket = stream_socket_client('tcp://' . $tcp->getAddress());
         fclose($socket);
 
-        $server = new AccountingServer($tcp);
+        $server = new LimitingServer($tcp, 100);
         $server->on('connection', $this->expectCallableOnce());
         $server->on('error', $this->expectCallableNever());
 
@@ -166,7 +160,7 @@ public function testPausingServerWillEmitOnlyOneButAcceptTwoConnectionsDueToOper
         $loop = Factory::create();
 
         $server = new Server(0, $loop);
-        $server = new AccountingServer($server, 1, true);
+        $server = new LimitingServer($server, 1, true);
         $server->on('connection', $this->expectCallableOnce());
         $server->on('error', $this->expectCallableNever());
 
@@ -187,7 +181,7 @@ public function testPausingServerWillEmitTwoConnectionsFromBacklog()
         $twice->expects($this->exactly(2))->method('__invoke');
 
         $server = new Server(0, $loop);
-        $server = new AccountingServer($server, 1, true);
+        $server = new LimitingServer($server, 1, true);
         $server->on('connection', $twice);
         $server->on('error', $this->expectCallableNever());