Merge pull request #50 from clue-labs/connectioninterface

clue · web-flow · commit bf7b31ef498a · 2016-12-19T23:24:06.000+01:00
ConnectionInterface should extend DuplexStreamInterface + documentation
diff --git a/README.md b/README.md
@@ -13,7 +13,8 @@ and [`Stream`](https://github.com/reactphp/stream) components.
 * [Quickstart example](#quickstart-example)
 * [Usage](#usage)
   * [Server](#server)
-  * [Connection](#connection)
+  * [ConnectionInterface](#connectioninterface)
+    * [getRemoteAddress()](#getremoteaddress)
 * [Install](#install)
 * [License](#license)
 
@@ -25,8 +26,8 @@ Here is a server that closes the connection if you send it anything:
 $loop = React\EventLoop\Factory::create();
 
 $socket = new React\Socket\Server($loop);
-$socket->on('connection', function ($conn) {
-    $conn->write("Hello there!\n");
+$socket->on('connection', function (ConnectionInterface $conn) {
+    $conn->write("Hello " . $conn->getRemoteAddress() . "!\n");
     $conn->write("Welcome to this amazing server!\n");
     $conn->write("Here's a tip: don't say anything.\n");
 
@@ -68,18 +69,68 @@ $loop->run();
 
 ### Server
 
-The server can listen on a port and will emit a `connection` event whenever a
-client connects.
+The `Server` class is responsible for listening on a port and waiting for new connections.
 
-### Connection
+Whenever a client connects, it will emit a `connection` event with a connection
+instance implementing [`ConnectionInterface`](#connectioninterface):
 
-The `Connection` is a readable and writable [`Stream`](https://github.com/reactphp/stream).
-The incoming connection represents the server-side end of the connection.
+```php
+$server->on('connection', function (ConnectionInterface $connection) {
+    …
+});
+```
+
+### ConnectionInterface
+
+The `ConnectionInterface` is used to represent any incoming connection.
+
+An incoming connection is a duplex stream (both readable and writable) that
+implements React's
+[`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface)
+and contains only a single additional property, the remote address (client IP)
+where this connection has been established from.
 
+> Note that this interface is only to be used to represent the server-side end
+of an incoming connection.
 It MUST NOT be used to represent an outgoing connection in a client-side context.
 If you want to establish an outgoing connection,
 use the [`SocketClient`](https://github.com/reactphp/socket-client) component instead.
 
+Because the `ConnectionInterface` implements the underlying
+[`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface)
+you can use any of its events and methods as usual:
+
+```php
+$connection->on('data', function ($chunk) {
+    echo $data;
+});
+
+$conenction->on('close', function () {
+    echo 'closed';
+});
+
+$connection->write($data);
+$connection->end($data = null);
+$connection->close();
+// …
+```
+
+For more details, see the
+[`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
+
+#### getRemoteAddress()
+
+The `getRemoteAddress(): ?string` method returns the remote address
+(client IP) where this connection has been established from.
+
+```php
+$ip = $connection->getRemoteAddress();
+```
+
+It will return the remote address as a string value.
+If the remote address can not be determined or is unknown at this time (such as
+after the connection has been closed), it MAY return a `NULL` value instead.
+
 ## Install
 
 The recommended way to install this library is [through Composer](http://getcomposer.org).
diff --git a/composer.json b/composer.json
@@ -7,7 +7,7 @@
         "php": ">=5.3.0",
         "evenement/evenement": "~2.0|~1.0",
         "react/event-loop": "0.4.*|0.3.*",
-        "react/stream": "0.4.*|0.3.*"
+        "react/stream": "^0.4.2"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/Connection.php b/src/Connection.php
@@ -4,6 +4,14 @@
 
 use React\Stream\Stream;
 
+/**
+ * The actual connection implementation for ConnectionInterface
+ *
+ * This class should only be used internally, see ConnectionInterface instead.
+ *
+ * @see ConnectionInterface
+ * @internal
+ */
 class Connection extends Stream implements ConnectionInterface
 {
     public function handleData($stream)
diff --git a/src/ConnectionInterface.php b/src/ConnectionInterface.php
@@ -2,11 +2,34 @@
 
 namespace React\Socket;
 
-use Evenement\EventEmitterInterface;
-use React\Stream\ReadableStreamInterface;
-use React\Stream\WritableStreamInterface;
+use React\Stream\DuplexStreamInterface;
 
-interface ConnectionInterface extends ReadableStreamInterface, WritableStreamInterface
+/**
+ * Any incoming connection is represented by this interface.
+ *
+ * An incoming connection is a duplex stream (both readable and writable) that
+ * implements React's DuplexStreamInterface and contains only a single
+ * additional property, the remote address (client IP) where this connection has
+ * been established from.
+ *
+ * Note that this interface is only to be used to represent the server-side end
+ * of an incoming connection.
+ * It MUST NOT be used to represent an outgoing connection in a client-side
+ * context.
+ * If you want to establish an outgoing connection,
+ * use React's SocketClient component instead.
+ *
+ * Because the `ConnectionInterface` implements the underlying
+ * `DuplexStreamInterface` you can use any of its events and methods as usual.
+ *
+ * @see DuplexStreamInterface
+ */
+interface ConnectionInterface extends DuplexStreamInterface
 {
+    /**
+     * Returns the remote address (client IP) where this connection has been established from
+     *
+     * @return string|null remote address (client IP) or null if unknown
+     */
     public function getRemoteAddress();
 }
