Merge pull request #55 from async-interop/info

Add Loop::info

Author: AndrewCarterUK

src/Loop.php

@@ -274,6 +274,32 @@ public static function setErrorHandler(callable $callback = null)
         self::get()->setErrorHandler($callback);
     }
 
+    /**
+     * Retrieve an associative array of information about the event loop driver.
+     *
+     * The returned array MUST contain the following data describing the driver's
+     * currently registered watchers:
+     *
+     *  [
+     *      "defer"         => ["enabled" => int, "disabled" => int],
+     *      "delay"         => ["enabled" => int, "disabled" => int],
+     *      "repeat"        => ["enabled" => int, "disabled" => int],
+     *      "on_readable"   => ["enabled" => int, "disabled" => int],
+     *      "on_writable"   => ["enabled" => int, "disabled" => int],
+     *      "on_signal"     => ["enabled" => int, "disabled" => int],
+     *      "watchers"      => ["referenced" => int, "unreferenced" => int],
+     *  ];
+     *
+     * Implementations MAY optionally add more information in the array but
+     * at minimum the above key => value format MUST always be provided.
+     *
+     * @return array
+     */
+    public static function info()
+    {
+        return self::get()->info();
+    }
+
     /**
      * Disable construction as this is a static class.
      */

src/LoopDriver.php

@@ -144,6 +144,29 @@ public function unreference($watcherId);
      */
     public function setErrorHandler(callable $callback = null);
 
+    /**
+     * Retrieve an associative array of information about the event loop driver.
+     *
+     * The returned array MUST contain the following data describing the driver's
+     * currently registered watchers:
+     *
+     *  [
+     *      "defer"         => ["enabled" => int, "disabled" => int],
+     *      "delay"         => ["enabled" => int, "disabled" => int],
+     *      "repeat"        => ["enabled" => int, "disabled" => int],
+     *      "on_readable"   => ["enabled" => int, "disabled" => int],
+     *      "on_writable"   => ["enabled" => int, "disabled" => int],
+     *      "on_signal"     => ["enabled" => int, "disabled" => int],
+     *      "watchers"      => ["referenced" => int, "unreferenced" => int],
+     *  ];
+     *
+     * Implementations MAY optionally add more information in the array but
+     * at minimum the above key => value format MUST always be provided.
+     *
+     * @return array
+     */
+    public function info();
+
     /**
      * Get the underlying loop handle.
      *