Merge pull request #13 from clue-labs/timers

Timed connectors now use $loop as last argument

Author: clue

README.md

@@ -73,14 +73,22 @@ $connectorRepeater->create('www.google.com', 80)->then(function ($stream) {
 
 ### Timeout
 
-The `ConnectionManagerTimeout($connector, $timeout)` sets a maximum `$timeout` in seconds on when to give up
+The `ConnectionManagerTimeout($connector, $timeout, $loop)` sets a maximum `$timeout` in seconds on when to give up
 waiting for the connection to complete.
 
+```php
+$connector = new ConnectionManagerTimeout($connector, 3.0, $loop);
+```
+
 ### Delay
 
-The `ConnectionManagerDelay($connector, $delay)` sets a fixed initial `$delay` in seconds before actually
+The `ConnectionManagerDelay($connector, $delay, $loop)` sets a fixed initial `$delay` in seconds before actually
 trying to connect. (Not to be confused with [`ConnectionManagerTimeout`](#timeout) which sets a _maximum timeout_.)
 
+```php
+$delayed = new ConnectionManagerDelayed($connector, 0.5, $loop);
+```
+
 ### Reject
 
 The `ConnectionManagerReject()` simply rejects every single connection attempt.
@@ -167,11 +175,11 @@ retrying unreliable hosts:
 
 ```php
 // delay connection by 2 seconds
-$delayed = new ConnectionManagerDelay($connector, $loop, 2.0);
+$delayed = new ConnectionManagerDelay($connector, 2.0, $loop);
 
 // maximum of 3 tries, each taking no longer than 3 seconds
 $retry = new ConnectionManagerRepeat(
-    new ConnectionManagerTimeout($connector, $loop, 3.0),
+    new ConnectionManagerTimeout($connector, 3.0, $loop),
     2
 );
 

src/ConnectionManagerDelay.php

@@ -9,14 +9,14 @@
 class ConnectionManagerDelay implements ConnectorInterface
 {
     private $connectionManager;
-    private $loop;
     private $delay;
+    private $loop;
 
-    public function __construct(ConnectorInterface $connectionManager, LoopInterface $loop, $delay)
+    public function __construct(ConnectorInterface $connectionManager, $delay, LoopInterface $loop)
     {
         $this->connectionManager = $connectionManager;
-        $this->loop = $loop;
         $this->delay = $delay;
+        $this->loop = $loop;
     }
 
     public function create($host, $port)

src/ConnectionManagerTimeout.php

@@ -10,14 +10,14 @@
 class ConnectionManagerTimeout implements ConnectorInterface
 {
     private $connectionManager;
-    private $loop;
     private $timeout;
+    private $loop;
 
-    public function __construct(ConnectorInterface $connectionManager, LoopInterface $loop, $timeout)
+    public function __construct(ConnectorInterface $connectionManager, $timeout, LoopInterface $loop)
     {
         $this->connectionManager = $connectionManager;
-        $this->loop = $loop;
         $this->timeout = $timeout;
+        $this->loop = $loop;
     }
 
     public function create($host, $port)

tests/ConnectionManagerDelayTest.php

@@ -15,7 +15,7 @@ public function setUp()
     public function testDelayTenth()
     {
         $will = $this->createConnectionManagerMock(true);
-        $cm = new ConnectionManagerDelay($will, $this->loop, 0.1);
+        $cm = new ConnectionManagerDelay($will, 0.1, $this->loop);
 
         $promise = $cm->create('www.google.com', 80);
         $this->assertInstanceOf('React\Promise\PromiseInterface', $promise);
@@ -29,7 +29,7 @@ public function testCancellationOfPromiseBeforeDelayDoesNotStartConnection()
         $unused = $this->getMock('React\SocketClient\ConnectorInterface');
         $unused->expects($this->never())->method('create');
 
-        $cm = new ConnectionManagerDelay($unused, $this->loop, 1.0);
+        $cm = new ConnectionManagerDelay($unused, 1.0, $this->loop);
 
         $promise = $cm->create('www.google.com', 80);
         $promise->cancel();

tests/ConnectionManagerTimeoutTest.php

@@ -10,6 +10,8 @@
 
 class ConnectionManagerTimeoutTest extends TestCase
 {
+    private $loop;
+
     public function setUp()
     {
         $this->loop = React\EventLoop\Factory::create();
@@ -18,7 +20,7 @@ public function setUp()
     public function testTimeoutOkay()
     {
         $will = $this->createConnectionManagerMock(true);
-        $cm = new ConnectionManagerTimeout($will, $this->loop, 0.1);
+        $cm = new ConnectionManagerTimeout($will, 0.1, $this->loop);
 
         $promise = $cm->create('www.google.com', 80);
         $this->assertInstanceOf('React\Promise\PromiseInterface', $promise);
@@ -30,9 +32,9 @@ public function testTimeoutOkay()
     public function testTimeoutExpire()
     {
         $will = $this->createConnectionManagerMock(new Stream(fopen('php://temp', 'r'), $this->loop));
-        $wont = new ConnectionManagerDelay($will, $this->loop, 0.2);
+        $wont = new ConnectionManagerDelay($will, 0.2, $this->loop);
 
-        $cm = new ConnectionManagerTimeout($wont, $this->loop, 0.1);
+        $cm = new ConnectionManagerTimeout($wont, 0.1, $this->loop);
 
         $promise = $cm->create('www.google.com', 80);
         $this->assertInstanceOf('React\Promise\PromiseInterface', $promise);
@@ -45,7 +47,7 @@ public function testTimeoutAbort()
     {
         $wont = new ConnectionManagerReject();
 
-        $cm = new ConnectionManagerTimeout($wont, $this->loop, 0.1);
+        $cm = new ConnectionManagerTimeout($wont, 0.1, $this->loop);
 
         $promise = $cm->create('www.google.com', 80);
         $this->assertInstanceOf('React\Promise\PromiseInterface', $promise);
@@ -69,7 +71,7 @@ public function testWillEndConnectionIfConnectionResolvesDespiteTimeout()
         $connector = $this->getMock('React\SocketClient\ConnectorInterface');
         $connector->expects($this->once())->method('create')->with('www.google.com', 80)->willReturn($promise);
 
-        $cm = new ConnectionManagerTimeout($connector, $this->loop, 0.001);
+        $cm = new ConnectionManagerTimeout($connector, 0.001, $this->loop);
 
         $promise = $cm->create('www.google.com', 80);
 
@@ -87,7 +89,7 @@ public function testCancellationOfPromiseWillCancelConnectionAttempt()
         $connector = $this->getMock('React\SocketClient\ConnectorInterface');
         $connector->expects($this->once())->method('create')->with('www.google.com', 80)->willReturn($promise);
 
-        $cm = new ConnectionManagerTimeout($connector, $this->loop, 5.0);
+        $cm = new ConnectionManagerTimeout($connector, 5.0, $this->loop);
 
         $promise = $cm->create('www.google.com', 80);
         $promise->cancel();