Merge pull request #133 from clue-labs/active

Remove unneeded isTimerActive() to reduce API surface

Author: WyriHaximus

README.md

@@ -29,7 +29,6 @@ For the code of the current stable 0.4.x release, checkout the
     * [addTimer()](#addtimer)
     * [addPeriodicTimer()](#addperiodictimer)
     * [cancelTimer()](#canceltimer)
-    * [isTimerActive()](#istimeractive)
     * [futureTick()](#futuretick)
     * [addSignal()](#addsignal)
     * [removeSignal()](#removesignal)
@@ -357,23 +356,8 @@ cancel a pending timer.
 
 See also [`addPeriodicTimer()`](#addperiodictimer) and [example #2](examples).
 
-You can use the [`isTimerActive()`](#istimeractive) method to check if
-this timer is still "active". After a timer is successfully cancelled,
-it is no longer considered "active".
-
 Calling this method on a timer instance that has not been added to this
-loop instance or on a timer that is not "active" (or has already been
-cancelled) has no effect.
-
-#### isTimerActive()
-
-The `isTimerActive(TimerInterface $timer): bool` method can be used to
-check if a given timer is active.
-
-A timer is considered "active" if it has been added to this loop instance
-via [`addTimer()`](#addtimer) or [`addPeriodicTimer()`](#addperiodictimer)
-and has not been cancelled via [`cancelTimer()`](#canceltimer) and is not
-a non-periodic timer that has already been triggered after its interval.
+loop instance or on a timer that has already been cancelled has no effect.
 
 #### futureTick()
 

src/ExtEventLoop.php

@@ -144,17 +144,12 @@ public function addPeriodicTimer($interval, callable $callback)
 
     public function cancelTimer(TimerInterface $timer)
     {
-        if ($this->isTimerActive($timer)) {
+        if ($this->timerEvents->contains($timer)) {
             $this->timerEvents[$timer]->free();
             $this->timerEvents->detach($timer);
         }
     }
 
-    public function isTimerActive(TimerInterface $timer)
-    {
-        return $this->timerEvents->contains($timer);
-    }
-
     public function futureTick(callable $listener)
     {
         $this->futureTickQueue->add($listener);
@@ -282,7 +277,7 @@ private function createTimerCallback()
         $this->timerCallback = function ($_, $__, $timer) {
             call_user_func($timer->getCallback(), $timer);
 
-            if (!$timer->isPeriodic() && $this->isTimerActive($timer)) {
+            if (!$timer->isPeriodic() && $this->timerEvents->contains($timer)) {
                 $this->cancelTimer($timer);
             }
         };

src/ExtLibevLoop.php

@@ -122,7 +122,7 @@ public function addTimer($interval, callable $callback)
         $callback = function () use ($timer) {
             call_user_func($timer->getCallback(), $timer);
 
-            if ($this->isTimerActive($timer)) {
+            if ($this->timerEvents->contains($timer)) {
                 $this->cancelTimer($timer);
             }
         };
@@ -157,11 +157,6 @@ public function cancelTimer(TimerInterface $timer)
         }
     }
 
-    public function isTimerActive(TimerInterface $timer)
-    {
-        return $this->timerEvents->contains($timer);
-    }
-
     public function futureTick(callable $listener)
     {
         $this->futureTickQueue->add($listener);

src/ExtLibeventLoop.php

@@ -164,7 +164,7 @@ public function addPeriodicTimer($interval, callable $callback)
 
     public function cancelTimer(TimerInterface $timer)
     {
-        if ($this->isTimerActive($timer)) {
+        if ($this->timerEvents->contains($timer)) {
             $event = $this->timerEvents[$timer];
 
             event_del($event);
@@ -174,11 +174,6 @@ public function cancelTimer(TimerInterface $timer)
         }
     }
 
-    public function isTimerActive(TimerInterface $timer)
-    {
-        return $this->timerEvents->contains($timer);
-    }
-
     public function futureTick(callable $listener)
     {
         $this->futureTickQueue->add($listener);
@@ -299,7 +294,7 @@ private function createTimerCallback()
             call_user_func($timer->getCallback(), $timer);
 
             // Timer already cancelled ...
-            if (!$this->isTimerActive($timer)) {
+            if (!$this->timerEvents->contains($timer)) {
                 return;
 
             // Reschedule periodic timers ...

src/LoopInterface.php

@@ -255,34 +255,15 @@ public function addPeriodicTimer($interval, callable $callback);
      *
      * See also [`addPeriodicTimer()`](#addperiodictimer) and [example #2](examples).
      *
-     * You can use the [`isTimerActive()`](#istimeractive) method to check if
-     * this timer is still "active". After a timer is successfully cancelled,
-     * it is no longer considered "active".
-     *
      * Calling this method on a timer instance that has not been added to this
-     * loop instance or on a timer that is not "active" (or has already been
-     * cancelled) has no effect.
+     * loop instance or on a timer that has already been cancelled has no effect.
      *
      * @param TimerInterface $timer The timer to cancel.
      *
      * @return void
      */
     public function cancelTimer(TimerInterface $timer);
 
-    /**
-     * Check if a given timer is active.
-     *
-     * A timer is considered "active" if it has been added to this loop instance
-     * via [`addTimer()`](#addtimer) or [`addPeriodicTimer()`](#addperiodictimer)
-     * and has not been cancelled via [`cancelTimer()`](#canceltimer) and is not
-     * a non-periodic timer that has already been triggered after its interval.
-     *
-     * @param TimerInterface $timer The timer to check.
-     *
-     * @return boolean True if the timer is still enqueued for execution.
-     */
-    public function isTimerActive(TimerInterface $timer);
-
     /**
      * Schedule a callback to be invoked on a future tick of the event loop.
      *

src/StreamSelectLoop.php

@@ -153,11 +153,6 @@ public function cancelTimer(TimerInterface $timer)
         $this->timers->cancel($timer);
     }
 
-    public function isTimerActive(TimerInterface $timer)
-    {
-        return $this->timers->contains($timer);
-    }
-
     public function futureTick(callable $listener)
     {
         $this->futureTickQueue->add($listener);

tests/Timer/AbstractTimerTest.php

@@ -73,19 +73,6 @@ public function testAddPeriodicTimerCancelsItself()
         $this->assertSame(2, $i);
     }
 
-    public function testIsTimerActive()
-    {
-        $loop = $this->createLoop();
-
-        $timer = $loop->addPeriodicTimer(0.001, function () {});
-
-        $this->assertTrue($loop->isTimerActive($timer));
-
-        $loop->cancelTimer($timer);
-
-        $this->assertFalse($loop->isTimerActive($timer));
-    }
-
     public function testMinimumIntervalOneMicrosecond()
     {
         $loop = $this->createLoop();