Merge pull request #64 from sirn-se/server-connections

Server connections

docs/Changelog.md

@@ -6,6 +6,10 @@
 
  > PHP version `^8.1`
 
+### `3.1.0`
+
+ * Server `getConnections()`, `getReadableConnections()`, `getWritableConnections()` (@sirn-se)
+
 ### `3.0.0`
 
  * Support `psr/log v3` (@sirn-se)

docs/Contributing.md

@@ -24,6 +24,7 @@ Base your patch on corresponding version branch, and target that version branch
 
 | Version | Branch | PHP | Status |
 | --- | --- | --- | --- |
+| [`3.1`](https://github.com/sirn-se/websocket-php/tree/3.1.0) | `v3.1-main` | `^8.1` | Under development |
 | [`3.0`](https://github.com/sirn-se/websocket-php/tree/3.0.0) | `v3.0-main` | `^8.1` | Current version |
 | [`2.2`](https://github.com/sirn-se/websocket-php/tree/2.2.0) | `v2.2-main` | `^8.0` | Bug fixes only |
 | [`2.1`](https://github.com/sirn-se/websocket-php/tree/2.1.0) | - | `^8.0` | Not supported |

docs/Server.md

@@ -49,7 +49,6 @@ echo "scheme:       {$server->getScheme()}\n";
 echo "timeout:      {$server->getTimeout()}s\n";
 echo "frame size:   {$server->getFrameSize()}b\n";
 echo "running:      {$server->isRunning()}\n";
-echo "connections:  {$server->getConnectionCount()}\n";
 echo "ssl:          {$server->isSsl()}\n";
 ```
 
@@ -170,12 +169,29 @@ $server->start();
 // Stop server - When called, server will no longer listen to incoming messages but will not disconnect clients
 $server->stop();
 
-//Disconnect server - Server will immediately stop and disconnect all clients without normal close procedure
+// Disconnect server - Server will immediately stop and disconnect all clients without normal close procedure
 $server->disconnect();
 ```
 
 To shut down server in an orderly fashion, you should first close all connected clients.
 
+
+## Server operations
+
+```php
+// Number of connected clients
+$server->getConnectionCount();
+
+// Get all current connections (may be in any state)
+$server->getConnections();
+
+// Get all readable connections
+$server->getReadableConnections();
+
+// Get all writable connections
+$server->getWritableConnections();
+```
+
 ## Connection control
 
 The Connection instance have some additional functions, besides sending messages to client.

src/Server.php

@@ -212,6 +212,37 @@ public function getConnectionCount(): int
         return count($this->connections);
     }
 
+    /**
+     * Get currently connected clients.
+     * @return array Connections
+     */
+    public function getConnections(): array
+    {
+        return $this->connections;
+    }
+
+    /**
+     * Get currently readable clients.
+     * @return array Connections
+     */
+    public function getReadableConnections(): array
+    {
+        return array_filter($this->connections, function (Connection $connection) {
+            return $connection->isReadable();
+        });
+    }
+
+    /**
+     * Get currently writable clients.
+     * @return array Connections
+     */
+    public function getWritableConnections(): array
+    {
+        return array_filter($this->connections, function (Connection $connection) {
+            return $connection->isWritable();
+        });
+    }
+
     /**
      * Add a middleware.
      * @param WebSocket\Middleware\MiddlewareInterface $middleware
@@ -304,7 +335,7 @@ public function start(): void
                         if ($connection) {
                             $connection->close($e->getCloseStatus(), $e->getMessage());
                         }
-                        $this->logger->error("[server] sss {$e->getMessage()}");
+                        $this->logger->error("[server] {$e->getMessage()}");
                         $this->dispatch('error', [$this, $connection, $e]);
                     }
                 }

tests/README.md

@@ -14,15 +14,16 @@ make test
 
 ## Continuous integration
 
-GitHub Actions are run on PHP versions `7.4`, `8.0`, `8.1` and `8.2`.
+GitHub Actions are run on PHP versions `8.1`, `8.2`, `8.3` and `8.4`.
 
-Code coverage by [Coveralls](https://coveralls.io/github/Textalk/websocket-php).
+Code coverage by [Coveralls](https://coveralls.io/github/sirn-se/websocket-php).
 
 
 ## Test strategy
 
-Test set up overloads various stream and socket functions,
-and use "scripts" to define and mock input/output of these functions.
+Uses the [phrity/net-mock](https://packagist.org/packages/phrity/net-mock) library to mock
+stream operations, implementing `expect<method>` before methods that uses stream interactions
+are called.
 
-This set up negates the dependency on running servers,
+This set up negates the dependency on running actual servers,
 and allow testing various errors that might occur.

tests/suites/server/ConfigTest.php

@@ -61,6 +61,9 @@ public function testServerDefaults(): void
         $this->assertEquals('tcp', $server->getScheme());
         $this->assertFalse($server->isRunning());
         $this->assertEquals(0, $server->getConnectionCount());
+        $this->assertEmpty($server->getConnections());
+        $this->assertEmpty($server->getReadableConnections());
+        $this->assertEmpty($server->getWritableConnections());
 
         $this->expectWsServerSetup(scheme: 'tcp', port: 8000);
         $this->expectStreamCollectionWaitRead()->addAssert(function ($method, $params) {
@@ -119,6 +122,11 @@ public function testServerConfiguration(): void
         $this->assertEquals('ssl', $server->getScheme());
         $this->assertFalse($server->isRunning());
         $this->assertEquals(1, $server->getConnectionCount());
+        $this->assertCount(1, $server->getConnections());
+        $this->expectSocketStreamIsReadable();
+        $this->assertCount(1, $server->getReadableConnections());
+        $this->expectSocketStreamIsWritable();
+        $this->assertCount(1, $server->getWritableConnections());
 
         $this->expectSocketStreamIsConnected();
         $this->expectSocketStreamClose();

tests/suites/server/ServerTest.php

@@ -466,6 +466,11 @@ public function testRunBadOpcodeException(): void
 
         // Should not have closed
         $this->assertEquals(1, $server->getConnectionCount());
+        $this->assertCount(1, $server->getConnections());
+        $this->expectSocketStreamIsReadable();
+        $this->assertCount(1, $server->getReadableConnections());
+        $this->expectSocketStreamIsWritable();
+        $this->assertCount(1, $server->getWritableConnections());
 
         $this->expectSocketStreamClose();
         $this->expectSocketServerClose();
@@ -510,6 +515,9 @@ public function testRunConnectionClosedException(): void
 
         // Should be closed
         $this->assertEquals(0, $server->getConnectionCount());
+        $this->assertEmpty($server->getConnections());
+        $this->assertEmpty($server->getReadableConnections());
+        $this->assertEmpty($server->getWritableConnections());
 
         $this->expectSocketServerClose();
         $server->disconnect();
@@ -551,6 +559,11 @@ public function testRunServerException(): void
 
         // Should not have closed
         $this->assertEquals(1, $server->getConnectionCount());
+        $this->assertCount(1, $server->getConnections());
+        $this->expectSocketStreamIsReadable();
+        $this->assertCount(1, $server->getReadableConnections());
+        $this->expectSocketStreamIsWritable();
+        $this->assertCount(1, $server->getWritableConnections());
 
         $this->expectSocketStreamClose();
         $this->expectSocketServerClose();