Merge pull request #187 from clue-labs/namespace-docs

WyriHaximus · web-flow · commit de2c87fe52fe · 2019-01-04T21:28:54.000+01:00
Update documentation to use full class names with namespaces
diff --git a/README.md b/README.md
diff --git a/examples/01-echo-server.php b/examples/01-echo-server.php
@@ -30,9 +30,9 @@
     )
 ));
 
-$server->on('connection', function (ConnectionInterface $conn) {
-    echo '[' . $conn->getRemoteAddress() . ' connected]' . PHP_EOL;
-    $conn->pipe($conn);
+$server->on('connection', function (ConnectionInterface $connection) {
+    echo '[' . $connection->getRemoteAddress() . ' connected]' . PHP_EOL;
+    $connection->pipe($connection);
 });
 
 $server->on('error', 'printf');
diff --git a/examples/03-http-server.php b/examples/03-http-server.php
@@ -43,10 +43,10 @@
     )
 ));
 
-$server->on('connection', function (ConnectionInterface $conn) {
-    $conn->once('data', function () use ($conn) {
+$server->on('connection', function (ConnectionInterface $connection) {
+    $connection->once('data', function () use ($connection) {
         $body = "<html><h1>Hello world!</h1></html>\r\n";
-        $conn->end("HTTP/1.1 200 OK\r\nContent-Length: " . strlen($body) . "\r\nConnection: close\r\n\r\n" . $body);
+        $connection->end("HTTP/1.1 200 OK\r\nContent-Length: " . strlen($body) . "\r\nConnection: close\r\n\r\n" . $body);
     });
 });
 
diff --git a/examples/91-benchmark-server.php b/examples/91-benchmark-server.php
@@ -36,18 +36,18 @@
     )
 ));
 
-$server->on('connection', function (ConnectionInterface $conn) use ($loop) {
+$server->on('connection', function (ConnectionInterface $connection) use ($loop) {
     echo '[connected]' . PHP_EOL;
 
     // count the number of bytes received from this connection
     $bytes = 0;
-    $conn->on('data', function ($chunk) use (&$bytes) {
+    $connection->on('data', function ($chunk) use (&$bytes) {
         $bytes += strlen($chunk);
     });
 
     // report average throughput once client disconnects
     $t = microtime(true);
-    $conn->on('close', function () use ($conn, $t, &$bytes) {
+    $connection->on('close', function () use ($connection, $t, &$bytes) {
         $t = microtime(true) - $t;
         echo '[disconnected after receiving ' . $bytes . ' bytes in ' . round($t, 3) . 's => ' . round($bytes / $t / 1024 / 1024, 1) . ' MiB/s]' . PHP_EOL;
     });
diff --git a/src/ConnectorInterface.php b/src/ConnectorInterface.php
@@ -30,7 +30,7 @@ interface ConnectorInterface
      *
      * ```php
      * $connector->connect('google.com:443')->then(
-     *     function (ConnectionInterface $connection) {
+     *     function (React\Socket\ConnectionInterface $connection) {
      *         // connection successfully established
      *     },
      *     function (Exception $error) {
diff --git a/src/FixedUriConnector.php b/src/FixedUriConnector.php
@@ -10,9 +10,9 @@
  * instead of connecting to a default address assumed by an higher-level API:
  *
  * ```php
- * $connector = new FixedUriConnector(
+ * $connector = new React\Socket\FixedUriConnector(
  *     'unix:///var/run/docker.sock',
- *     new UnixConnector($loop)
+ *     new React\Socket\UnixConnector($loop)
  * );
  *
  * // destination will be ignored, actually connects to Unix domain socket
diff --git a/src/LimitingServer.php b/src/LimitingServer.php
@@ -21,8 +21,8 @@
  * open connections.
  *
  * ```php
- * $server = new LimitingServer($server, 100);
- * $server->on('connection', function (ConnectionInterface $connection) {
+ * $server = new React\Socket\LimitingServer($server, 100);
+ * $server->on('connection', function (React\Socket\ConnectionInterface $connection) {
  *     $connection->write('hello there!' . PHP_EOL);
  *     …
  * });
@@ -52,8 +52,8 @@ class LimitingServer extends EventEmitter implements ServerInterface
      * this and no `connection` event will be emitted.
      *
      * ```php
-     * $server = new LimitingServer($server, 100);
-     * $server->on('connection', function (ConnectionInterface $connection) {
+     * $server = new React\Socket\LimitingServer($server, 100);
+     * $server->on('connection', function (React\Socket\ConnectionInterface $connection) {
      *     $connection->write('hello there!' . PHP_EOL);
      *     …
      * });
@@ -81,8 +81,8 @@ class LimitingServer extends EventEmitter implements ServerInterface
      * an interactive chat).
      *
      * ```php
-     * $server = new LimitingServer($server, 100, true);
-     * $server->on('connection', function (ConnectionInterface $connection) {
+     * $server = new React\Socket\LimitingServer($server, 100, true);
+     * $server->on('connection', function (React\Socket\ConnectionInterface $connection) {
      *     $connection->write('hello there!' . PHP_EOL);
      *     …
      * });
diff --git a/src/SecureServer.php b/src/SecureServer.php
@@ -15,8 +15,8 @@
  * TCP/IP connections and then performs a TLS handshake for each connection.
  *
  * ```php
- * $server = new TcpServer(8000, $loop);
- * $server = new SecureServer($server, $loop, array(
+ * $server = new React\Socket\TcpServer(8000, $loop);
+ * $server = new React\Socket\SecureServer($server, $loop, array(
  *     // tls context options here…
  * ));
  * ```
@@ -25,7 +25,7 @@
  * with a connection instance implementing [`ConnectionInterface`](#connectioninterface):
  *
  * ```php
- * $server->on('connection', function (ConnectionInterface $connection) {
+ * $server->on('connection', function (React\Socket\ConnectionInterface $connection) {
  *     echo 'Secure connection from' . $connection->getRemoteAddress() . PHP_EOL;
  *
  *     $connection->write('hello there!' . PHP_EOL);
@@ -67,8 +67,8 @@ final class SecureServer extends EventEmitter implements ServerInterface
      * PEM encoded certificate file:
      *
      * ```php
-     * $server = new TcpServer(8000, $loop);
-     * $server = new SecureServer($server, $loop, array(
+     * $server = new React\Socket\TcpServer(8000, $loop);
+     * $server = new React\Socket\SecureServer($server, $loop, array(
      *     'local_cert' => 'server.pem'
      * ));
      * ```
@@ -82,8 +82,8 @@ final class SecureServer extends EventEmitter implements ServerInterface
      * like this:
      *
      * ```php
-     * $server = new TcpServer(8000, $loop);
-     * $server = new SecureServer($server, $loop, array(
+     * $server = new React\Socket\TcpServer(8000, $loop);
+     * $server = new React\Socket\SecureServer($server, $loop, array(
      *     'local_cert' => 'server.pem',
      *     'passphrase' => 'secret'
      * ));
diff --git a/src/ServerInterface.php b/src/ServerInterface.php
@@ -23,7 +23,7 @@
  *     established, i.e. a new client connects to this server socket:
  *
  *     ```php
- *     $server->on('connection', function (ConnectionInterface $connection) {
+ *     $server->on('connection', function (React\Socket\ConnectionInterface $connection) {
  *         echo 'new connection' . PHP_EOL;
  *     });
  *     ```
diff --git a/src/TcpServer.php b/src/TcpServer.php
@@ -12,14 +12,14 @@
  * is responsible for accepting plaintext TCP/IP connections.
  *
  * ```php
- * $server = new TcpServer(8080, $loop);
+ * $server = new React\Socket\TcpServer(8080, $loop);
  * ```
  *
  * Whenever a client connects, it will emit a `connection` event with a connection
  * instance implementing `ConnectionInterface`:
  *
  * ```php
- * $server->on('connection', function (ConnectionInterface $connection) {
+ * $server->on('connection', function (React\Socket\ConnectionInterface $connection) {
  *     echo 'Plaintext connection from ' . $connection->getRemoteAddress() . PHP_EOL;
  *     $connection->write('hello there!' . PHP_EOL);
  *     …
@@ -45,7 +45,7 @@ final class TcpServer extends EventEmitter implements ServerInterface
      * for more details.
      *
      * ```php
-     * $server = new TcpServer(8080, $loop);
+     * $server = new React\Socket\TcpServer(8080, $loop);
      * ```
      *
      * As above, the `$uri` parameter can consist of only a port, in which case the
@@ -55,7 +55,7 @@ final class TcpServer extends EventEmitter implements ServerInterface
      * In order to use a random port assignment, you can use the port `0`:
      *
      * ```php
-     * $server = new TcpServer(0, $loop);
+     * $server = new React\Socket\TcpServer(0, $loop);
      * $address = $server->getAddress();
      * ```
      *
@@ -64,33 +64,33 @@ final class TcpServer extends EventEmitter implements ServerInterface
      * preceded by the `tcp://` scheme:
      *
      * ```php
-     * $server = new TcpServer('192.168.0.1:8080', $loop);
+     * $server = new React\Socket\TcpServer('192.168.0.1:8080', $loop);
      * ```
      *
      * If you want to listen on an IPv6 address, you MUST enclose the host in square
      * brackets:
      *
      * ```php
-     * $server = new TcpServer('[::1]:8080', $loop);
+     * $server = new React\Socket\TcpServer('[::1]:8080', $loop);
      * ```
      *
      * If the given URI is invalid, does not contain a port, any other scheme or if it
      * contains a hostname, it will throw an `InvalidArgumentException`:
      *
      * ```php
      * // throws InvalidArgumentException due to missing port
-     * $server = new TcpServer('127.0.0.1', $loop);
+     * $server = new React\Socket\TcpServer('127.0.0.1', $loop);
      * ```
      *
      * If the given URI appears to be valid, but listening on it fails (such as if port
      * is already in use or port below 1024 may require root access etc.), it will
      * throw a `RuntimeException`:
      *
      * ```php
-     * $first = new TcpServer(8080, $loop);
+     * $first = new React\Socket\TcpServer(8080, $loop);
      *
      * // throws RuntimeException because port is already in use
-     * $second = new TcpServer(8080, $loop);
+     * $second = new React\Socket\TcpServer(8080, $loop);
      * ```
      *
      * Note that these error conditions may vary depending on your system and/or
@@ -102,7 +102,7 @@ final class TcpServer extends EventEmitter implements ServerInterface
      * for the underlying stream socket resource like this:
      *
      * ```php
-     * $server = new TcpServer('[::1]:8080', $loop, array(
+     * $server = new React\Socket\TcpServer('[::1]:8080', $loop, array(
      *     'backlog' => 200,
      *     'so_reuseport' => true,
      *     'ipv6_v6only' => true
diff --git a/src/UnixServer.php b/src/UnixServer.php
@@ -12,7 +12,7 @@
  * is responsible for accepting plaintext connections on unix domain sockets.
  *
  * ```php
- * $server = new UnixServer('unix:///tmp/app.sock', $loop);
+ * $server = new React\Socket\UnixServer('unix:///tmp/app.sock', $loop);
  * ```
  *
  * See also the `ServerInterface` for more details.
@@ -34,7 +34,7 @@ final class UnixServer extends EventEmitter implements ServerInterface
      * for more details.
      *
      * ```php
-     * $server = new UnixServer('unix:///tmp/app.sock', $loop);
+     * $server = new React\Socket\UnixServer('unix:///tmp/app.sock', $loop);
      * ```
      *
      * @param string        $path

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ interface ConnectorInterface`
`30`	`30`	`*`
`31`	`31`	* ```php
`32`	`32`	`* $connector->connect('google.com:443')->then(`
`33`		`- * function (ConnectionInterface $connection) {`
	`33`	`+ * function (React\Socket\ConnectionInterface $connection) {`
`34`	`34`	`* // connection successfully established`
`35`	`35`	`* },`
`36`	`36`	`* function (Exception $error) {`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,9 @@`
`10`	`10`	`* instead of connecting to a default address assumed by an higher-level API:`
`11`	`11`	`*`
`12`	`12`	* ```php
`13`		`- * $connector = new FixedUriConnector(`
	`13`	`+ * $connector = new React\Socket\FixedUriConnector(`
`14`	`14`	`* 'unix:///var/run/docker.sock',`
`15`		`- * new UnixConnector($loop)`
	`15`	`+ * new React\Socket\UnixConnector($loop)`
`16`	`16`	`* );`
`17`	`17`	`*`
`18`	`18`	`* // destination will be ignored, actually connects to Unix domain socket`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`* established, i.e. a new client connects to this server socket:`
`24`	`24`	`*`
`25`	`25`	* ```php
`26`		`- * $server->on('connection', function (ConnectionInterface $connection) {`
	`26`	`+ * $server->on('connection', function (React\Socket\ConnectionInterface $connection) {`
`27`	`27`	`* echo 'new connection' . PHP_EOL;`
`28`	`28`	`* });`
`29`	`29`	* ```
Original file line number	Diff line number	Diff line change
`@@ -12,14 +12,14 @@`
`12`	`12`	`* is responsible for accepting plaintext TCP/IP connections.`
`13`	`13`	`*`
`14`	`14`	* ```php
`15`		`- * $server = new TcpServer(8080, $loop);`
	`15`	`+ * $server = new React\Socket\TcpServer(8080, $loop);`
`16`	`16`	* ```
`17`	`17`	`*`
`18`	`18`	* Whenever a client connects, it will emit a `connection` event with a connection
`19`	`19`	* instance implementing `ConnectionInterface`:
`20`	`20`	`*`
`21`	`21`	* ```php
`22`		`- * $server->on('connection', function (ConnectionInterface $connection) {`
	`22`	`+ * $server->on('connection', function (React\Socket\ConnectionInterface $connection) {`
`23`	`23`	`* echo 'Plaintext connection from ' . $connection->getRemoteAddress() . PHP_EOL;`
`24`	`24`	`* $connection->write('hello there!' . PHP_EOL);`
`25`	`25`	`* …`
`@@ -45,7 +45,7 @@ final class TcpServer extends EventEmitter implements ServerInterface`
`45`	`45`	`* for more details.`
`46`	`46`	`*`
`47`	`47`	* ```php
`48`		`- * $server = new TcpServer(8080, $loop);`
	`48`	`+ * $server = new React\Socket\TcpServer(8080, $loop);`
`49`	`49`	* ```
`50`	`50`	`*`
`51`	`51`	* As above, the `$uri` parameter can consist of only a port, in which case the
`@@ -55,7 +55,7 @@ final class TcpServer extends EventEmitter implements ServerInterface`
`55`	`55`	* In order to use a random port assignment, you can use the port `0`:
`56`	`56`	`*`
`57`	`57`	* ```php
`58`		`- * $server = new TcpServer(0, $loop);`
	`58`	`+ * $server = new React\Socket\TcpServer(0, $loop);`
`59`	`59`	`* $address = $server->getAddress();`
`60`	`60`	* ```
`61`	`61`	`*`
`@@ -64,33 +64,33 @@ final class TcpServer extends EventEmitter implements ServerInterface`
`64`	`64`	* preceded by the `tcp://` scheme:
`65`	`65`	`*`
`66`	`66`	* ```php
`67`		`- * $server = new TcpServer('192.168.0.1:8080', $loop);`
	`67`	`+ * $server = new React\Socket\TcpServer('192.168.0.1:8080', $loop);`
`68`	`68`	* ```
`69`	`69`	`*`
`70`	`70`	`* If you want to listen on an IPv6 address, you MUST enclose the host in square`
`71`	`71`	`* brackets:`
`72`	`72`	`*`
`73`	`73`	* ```php
`74`		`- * $server = new TcpServer('[::1]:8080', $loop);`
	`74`	`+ * $server = new React\Socket\TcpServer('[::1]:8080', $loop);`
`75`	`75`	* ```
`76`	`76`	`*`
`77`	`77`	`* If the given URI is invalid, does not contain a port, any other scheme or if it`
`78`	`78`	* contains a hostname, it will throw an `InvalidArgumentException`:
`79`	`79`	`*`
`80`	`80`	* ```php
`81`	`81`	`* // throws InvalidArgumentException due to missing port`
`82`		`- * $server = new TcpServer('127.0.0.1', $loop);`
	`82`	`+ * $server = new React\Socket\TcpServer('127.0.0.1', $loop);`
`83`	`83`	* ```
`84`	`84`	`*`
`85`	`85`	`* If the given URI appears to be valid, but listening on it fails (such as if port`
`86`	`86`	`* is already in use or port below 1024 may require root access etc.), it will`
`87`	`87`	* throw a `RuntimeException`:
`88`	`88`	`*`
`89`	`89`	* ```php
`90`		`- * $first = new TcpServer(8080, $loop);`
	`90`	`+ * $first = new React\Socket\TcpServer(8080, $loop);`
`91`	`91`	`*`
`92`	`92`	`* // throws RuntimeException because port is already in use`
`93`		`- * $second = new TcpServer(8080, $loop);`
	`93`	`+ * $second = new React\Socket\TcpServer(8080, $loop);`
`94`	`94`	* ```
`95`	`95`	`*`
`96`	`96`	`* Note that these error conditions may vary depending on your system and/or`
`@@ -102,7 +102,7 @@ final class TcpServer extends EventEmitter implements ServerInterface`
`102`	`102`	`* for the underlying stream socket resource like this:`
`103`	`103`	`*`
`104`	`104`	* ```php
`105`		`- * $server = new TcpServer('[::1]:8080', $loop, array(`
	`105`	`+ * $server = new React\Socket\TcpServer('[::1]:8080', $loop, array(`
`106`	`106`	`* 'backlog' => 200,`
`107`	`107`	`* 'so_reuseport' => true,`
`108`	`108`	`* 'ipv6_v6only' => true`