Added flag shutdown functionality

Author: AndrewCarterUK

src/DaemonInterface.php

@@ -47,4 +47,10 @@ interface DaemonInterface
      * @throws \Exception On fatal error
      */
     public function run();
+
+    /**
+     * Flag the daemon for shutting down. This will stop it from accepting
+     * requests.
+     */
+    public function flagShutdown();
 }

src/DaemonTrait.php

@@ -9,6 +9,11 @@
 
 trait DaemonTrait
 {
+    /**
+     * @var bool
+     */
+    private $isShutdown = false;
+
     /**
      * @var int
      */
@@ -24,6 +29,14 @@ trait DaemonTrait
      */
     private $memoryLimit;
 
+    /**
+     * Flags the daemon for shutting down.
+     */
+    public function flagShutdown()
+    {
+        $this->isShutdown = true;
+    }
+
     /**
      * Loads to configuration from the daemon options and installs signal
      * handlers.
@@ -76,12 +89,17 @@ private function installSignalHandlers()
 
     /**
      * Checks the current PHP process against the limits specified in a daemon
-     * options object.
+     * options object. This function will also throw an exception if the daemon
+     * has been flagged for shutdown.
      *
      * @throws ShutdownException When limits in the daemon options are exceeded
      */
     private function checkDaemonLimits()
     {
+        if ($this->isShutdown) {
+            throw new ShutdownException('Daemon flagged for shutdown');
+        }
+
         pcntl_signal_dispatch();
 
         if (DaemonOptions::NO_LIMIT !== $this->requestLimit) {

src/Exception/ShutdownException.php

@@ -8,6 +8,6 @@
  * They may be triggered by a SIGINT or by exceeding limits specified in the
  * daemon configuration (such as memory and request limits).
  */
-class ShutdownException extends \RuntimeException
+class ShutdownException extends DaemonException
 {
 }

test/Driver/Userland/UserlandDaemonTest.php

@@ -19,7 +19,21 @@
 class UserlandDaemonTest extends \PHPUnit_Framework_TestCase
 {
     /**
-     * Tests that the daemon shuts down after reaching its request .
+     * Tests that the daemon shuts down after being flagged for shutdown.
+     */
+    public function testFlagShutdown()
+    {
+        // Set a memory limit to make sure that it isn't breached (added 10MB on top of peak usage)
+        $context = $this->createTestingContext(1, memory_get_peak_usage() + (10 * 1024 * 1024));
+
+        $context['daemon']->flagShutdown();
+        $context['daemon']->run();
+
+        $this->assertEquals('Daemon flagged for shutdown', $context['logger']->getMessages()[0]['message']);
+    }
+
+    /**
+     * Tests that the daemon shuts down after reaching its request.
      */
     public function testRequestLimit()
     {

test/Helper/Mocker/MockDaemon.php

@@ -12,4 +12,8 @@ public function run()
     {
         return $this->delegateCall('run', func_get_args());
     }
+
+    public function flagShutdown()
+    {
+    }
 }