zwilias / qman

Ev.php

Doc Comments +1 added lines, -1 removed lines

@@ -980,7 +980,7 @@
      * Initiates the stat call(updates internal cache). It stats (using lstat) the path specified in the watcher and
      * sets the internal cache to the values found.
      *
-     * @return bool TRUE if path exists. Otherwise FALSE.
+     * @return boolean|null TRUE if path exists. Otherwise FALSE.
      */
     public function stat() {}
 

Braces +246 added lines, -83 removed lines

@@ -218,7 +218,9 @@ 
      *
      * @return int Bit mask describing the backend used by libev, see Ev::BACKEND_* flags.
      */
-    final public static function backend() {}
+    final public static function backend()
+    {
+}
 
     /**
      * Returns recursion depth
@@ -229,14 +231,18 @@ 
      *
      * @return int Recursion depth of the default loop.
      */
-    final public static function depth() {}
+    final public static function depth()
+    {
+}
 
     /**
      * Returns the set of backends that are embeddable in other event loops.
      *
      * @return int Bit mask which can contain Ev::BACKEND_* flags combined using bitwise OR operator.
      */
-    final public static function embeddableBackends() {}
+    final public static function embeddableBackends()
+    {
+}
 
     /**
      * Feed signal event into Ev
@@ -249,7 +255,9 @@ 
      * @param int $signum Signal number. See signal(7) man page for details. You can use constants exported by pcntl
      *      extension.
      */
-    final public static function feedSignal($signum) {}
+    final public static function feedSignal($signum)
+    {
+}
 
     /**
      * Feed signal event into the default loop
@@ -260,7 +268,9 @@ 
      * @param int $signum Signal number. See signal(7) man page for details. See also constants exported by pcntl
      *      extension.
      */
-    final public static function feedSignalEvent($signum) {}
+    final public static function feedSignalEvent($signum)
+    {
+}
 
     /**
      * Return the number of times the default event loop has polled for new events.
@@ -269,7 +279,9 @@ 
      *
      * @return int Number of polls of the default event loop.
      */
-    final public static function iteration() {}
+    final public static function iteration()
+    {
+}
 
     /**
      * Returns the time when the last iteration of the default event loop has started.
@@ -280,7 +292,9 @@ 
      * @return float Number of seconds(fractional) representing the time when the last iteration of the default event
      *      loop has started.
      */
-    final public static function now() {}
+    final public static function now()
+    {
+}
 
     /**
      * Establishes the current time by querying the kernel, updating the time returned by Ev::now in the progress.
@@ -291,7 +305,9 @@ 
      * This method is rarely useful, but when some event callback runs for a very long time without entering the event
      * loop, updating libev's consideration of the current time is a good idea.
      */
-    final public static function nowUpdate() {}
+    final public static function nowUpdate()
+    {
+}
 
     /**
      * Returns a bit mask of recommended backends for current platform.
@@ -304,7 +320,9 @@ 
      *
      * @return int Bit mask which can contain Ev::BACKEND_* flags combined using bitwise OR operator.
      */
-    final public static function recommendedBackends() {}
+    final public static function recommendedBackends()
+    {
+}
 
     /**
      * Resume previously suspended default event loop.
@@ -319,7 +337,9 @@ 
      *
      * Calling suspend / resume has the side effect of updating the event loop time (see Ev::nowUpdate()).
      */
-    final public static function resume() {}
+    final public static function resume()
+    {
+}
 
     /**
      * Begin checking for events and calling callbacks for the default loop.
@@ -331,28 +351,36 @@ 
      *
      * @param int $flags One of the Ev::FLAG_* flags
      */
-    final public static function run($flags = self::FLAG_AUTO) {}
+    final public static function run($flags = self::FLAG_AUTO)
+    {
+}
 
     /**
      * Block the process for the given number of seconds.
      *
      * @param float $seconds Fractional number of seconds
      */
-    final public static function sleep($seconds) {}
+    final public static function sleep($seconds)
+    {
+}
 
     /**
      * Stops the default event loop
      *
      * @param int $how One of the Ev::BREAK_* constants
      */
-    final public static function stop($how = self::BREAK_ONE) {}
+    final public static function stop($how = self::BREAK_ONE)
+    {
+}
 
     /**
      * Returns the set of backends supported by current libev configuration.
      *
      * @return int Bit mask which can contain Ev::BACKEND_* flags combined using bitwise OR operator.
      */
-    final public static function supportedBackends() {}
+    final public static function supportedBackends()
+    {
+}
 
     /**
      * Suspend the default event loop.
@@ -365,7 +393,9 @@ 
      * After calling Ev::suspend() it is not allowed to call any function on the given loop other than Ev::resume().
      * Also it is not allowed to call Ev::resume() without a previous call to Ev::suspend().
      */
-    final public static function suspend() {}
+    final public static function suspend()
+    {
+}
 
     /**
      * Returns the current time in fractional seconds since the epoch.
@@ -374,7 +404,9 @@ 
      *
      * @return float The current time in fractional seconds since the epoch.
      */
-    final public static function time() {}
+    final public static function time()
+    {
+}
 
     /**
      * Performs internal consistency checks (for debugging).
@@ -382,7 +414,9 @@ 
      * Performs internal consistency checks (for debugging libev) and abort the program if any data structures were
      * found to be corrupted.
      */
-    final public static function verify() {}
+    final public static function verify()
+    {
+}
 }
 
 /**
@@ -421,7 +455,9 @@ 
      * @return int In case if the watcher is pending, returns revents bitset as if the watcher callback had been
      *      invoked. Otherwise returns 0 .
      */
-    public function clear() {}
+    public function clear()
+    {
+}
 
     /**
      * Feeds the given revents set into the event loop.
@@ -430,21 +466,27 @@ 
      *
      * @param int $events Bit mask of watcher received events.
      */
-    public function feed($events) {}
+    public function feed($events)
+    {
+}
 
     /**
      * Returns the loop responsible for the watcher.
      *
      * @return EvLoop Event loop object responsible for the watcher.
      */
-    public function getLoop() {}
+    public function getLoop()
+    {
+}
 
     /**
      * Invokes the watcher callback with the given received events bit mask.
      *
      * @param int $events Bit mask of watcher received events.
      */
-    public function invoke($events) {}
+    public function invoke($events)
+    {
+}
 
     /**
      * Configures whether to keep the loop from returning.
@@ -460,28 +502,36 @@ 
      * @param bool $value With keepalive value set to FALSE the watcher won't keep Ev::run() / EvLoop::run() from
      *      returning even though the watcher is active.
      */
-    public function keepAlive($value) {}
+    public function keepAlive($value)
+    {
+}
 
     /**
      * Sets new callback for the watcher.
      *
      * @param callable $callback void callback ([ object $watcher = NULL [, int $revents = NULL ]] )
      */
-    public function setCallback(callable $callback) {}
+    public function setCallback(callable $callback)
+    {
+}
 
     /**
      * Starts the watcher.
      *
      * Marks the watcher as active. Note that only active watchers will receive events.
      */
-    public function start() {}
+    public function start()
+    {
+}
 
     /**
      * Stops the watcher.
      *
      * Marks the watcher as inactive. Note that only active watchers will receive events.
      */
-    public function stop() {}
+    public function stop()
+    {
+}
 }
 
 /**
@@ -512,7 +562,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct(callable $callback, $data = null, $priority = 0) {}
+    public function __construct(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * @param callable $callback
@@ -520,7 +572,9 @@ 
      * @param int $priority
      * @return EvCheck
      */
-    final public static function createStopped(callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped(callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -565,7 +619,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct($pid, $trace, callable $callback, $data = null, $priority = 0) {}
+    public function __construct($pid, $trace, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Create instance of a stopped EvCheck watcher.
@@ -581,7 +637,9 @@ 
      *
      * @return EvChild
      */
-    final public static function createStopped($pid, $trace, callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped($pid, $trace, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Configures the watcher
@@ -590,7 +648,9 @@ 
      * @param bool $trace If FALSE, only activate the watcher when the process terminates. Otherwise(TRUE) additionally
      *      activate the watcher when the process is stopped or continued.
      */
-    public function set($pid, $trace) {}
+    public function set($pid, $trace)
+    {
+}
 }
 
 /**
@@ -619,19 +679,25 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct(EvLoop $embed, callable $callback, $data = null, $priority = 0) {}
+    public function __construct(EvLoop $embed, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Configures the watcher.
      *
      * @param EvLoop $embed The loop to embed, this loop must be embeddable(see Ev::embeddableBackends()).
      */
-    public function set(EvLoop $embed) {}
+    public function set(EvLoop $embed)
+    {
+}
 
     /**
      * Make a single, non-blocking sweep over the embedded loop.
      */
-    public function sweep() {}
+    public function sweep()
+    {
+}
 
     /**
      * Create stopped EvEmbed watcher object
@@ -645,7 +711,9 @@ 
      *
      * @return EvEmbed
      */
-    final public static function createStopped(EvLoop $embed, callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped(EvLoop $embed, callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -686,7 +754,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct($fd, $events, callable $callback, $data = null, $priority = 0) {}
+    public function __construct($fd, $events, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Configures the watcher.
@@ -694,7 +764,9 @@ 
      * @param resource $fd  A stream opened with fopen() or similar functions, numeric file descriptor, or socket.
      * @param int $events Ev::READ and/or Ev::WRITE. See the bit masks.
      */
-    public function set($fd, $events) {}
+    public function set($fd, $events)
+    {
+}
 
     /**
      * Create stopped EvIo watcher object.
@@ -709,7 +781,9 @@ 
      *
      * @return EvIo
      */
-    final public static function createStopped($fd, $events, callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped($fd, $events, callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -767,14 +841,17 @@ 
      */
     public function __construct(
         $offset, $interval, callable $reschedule_cb = null, callable $callback, $data = null, $priority = 0
-    ) {}
+    ) {
+}
 
     /**
      * Simply stops and restarts the periodic watcher again.
      *
      * Simply stops and restarts the periodic watcher again. This is only useful when attributes are changed.
      */
-    public function again() {}
+    public function again()
+    {
+}
 
     /**
      * Returns the absolute time that this watcher is supposed to trigger next.
@@ -785,7 +862,9 @@ 
      *
      * @return double Rhe absolute time this watcher is supposed to trigger next in seconds.
      */
-    public function at() {}
+    public function at()
+    {
+}
 
     /**
      * Create a stopped EvPeriodic watcher
@@ -808,7 +887,8 @@ 
      */
     final public static function createStopped(
         $offset, $interval, callable $reschedule_cb = null, callable $callback, $data = null, $priority = 0
-    ) {}
+    ) {
+}
 }
 
 /**
@@ -844,7 +924,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct(callable $callback, $data = null, $priority = 0) {}
+    public function __construct(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates a stopped instance of EvPrepare watcher.
@@ -858,7 +940,9 @@ 
      *
      * @return EvPrepare
      */
-    final public static function createStopped(callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped(callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -888,14 +972,18 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct($signum, callable $callback, $data = null, $priority = 0) {}
+    public function __construct($signum, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Configures the watcher.
      *
      * @param int $signum Signal number. See the constants exported by pcntl extension. See also signal(7) man page.
      */
-    public function set($signum) {}
+    public function set($signum)
+    {
+}
 
     /**
      * Creates a stopped instance of EvSignal watcher.
@@ -910,7 +998,9 @@ 
      *
      * @return EvSignal
      */
-    final public static function createStopped($signum, callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped($signum, callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -953,17 +1043,23 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct($path, $interval, callable $callback, $data = null, $priority = 0) {}
+    public function __construct($path, $interval, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * @return array The values most recently detect by Ev (without actual stat'ing). See stat(2) man page for details.
      */
-    public function attr() {}
+    public function attr()
+    {
+}
 
     /**
      * @return array Just like EvStat::attr() , but returns the previous set of values.
      */
-    public function prev() {}
+    public function prev()
+    {
+}
 
     /**
      * Configures the watcher.
@@ -972,7 +1068,9 @@ 
      * @param double $interval Hint on how quickly a change is expected to be detected and should normally be specified
      *      as 0.0 to let libev choose a suitable value.
      */
-    public function set($path, $interval) {}
+    public function set($path, $interval)
+    {
+}
 
     /**
      * Initiates the stat call.
@@ -982,7 +1080,9 @@ 
      *
      * @return bool TRUE if path exists. Otherwise FALSE.
      */
-    public function stat() {}
+    public function stat()
+    {
+}
 
     /**
      * Create a stopped EvStat watcher object.
@@ -998,7 +1098,9 @@ 
      *
      * @return EvStat
      */
-    final public static function createStopped($path, $interval, callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped($path, $interval, callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -1052,7 +1154,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct($after, $repeat, callable $callback, $data = null, $priority = 0) {}
+    public function __construct($after, $repeat, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Restarts the timer watcher.
@@ -1064,7 +1168,9 @@ 
      * - if the timer is repeating, either start it if necessary (with the repeat value), or reset the running timer to
      *   the repeat value.
      */
-    public function again() {}
+    public function again()
+    {
+}
 
     /**
      * Configures the watcher.
@@ -1074,7 +1180,9 @@ 
      *      is positive, then the timer will automatically be configured to trigger again every repeat seconds later,
      *      until stopped manually.
      */
-    public function set($after, $repeat) {}
+    public function set($after, $repeat)
+    {
+}
 
     /**
      * Creates a stopped EvTimer watcher object.
@@ -1089,7 +1197,9 @@ 
      *
      * @return EvTimer
      */
-    final public static function createStopped($after, $repeat, callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped($after, $repeat, callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -1119,7 +1229,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct(callable $callback, $data = null, $priority = 0) {}
+    public function __construct(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates a stopped EvIdle instance.
@@ -1130,7 +1242,9 @@ 
      *
      * @return EvIdle
      */
-    final public static function createStopped(callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped(callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -1152,7 +1266,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function __construct(callable $callback, $data = null, $priority = 0) {}
+    public function __construct(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates a stopped EvFork instance.
@@ -1163,7 +1279,9 @@ 
      *
      * @return EvFork
      */
-    final public static function createStopped(callable $callback, $data = null, $priority = 0) {}
+    final public static function createStopped(callable $callback, $data = null, $priority = 0)
+    {
+}
 }
 
 /**
@@ -1226,14 +1344,18 @@ 
      * @param float $io_interval
      * @param float $timeout_interval
      */
-    public function __construct($flags = Ev::FLAG_AUTO, $data = null, $io_interval = 0.0, $timeout_interval = 0.0) {}
+    public function __construct($flags = Ev::FLAG_AUTO, $data = null, $io_interval = 0.0, $timeout_interval = 0.0)
+    {
+}
 
     /**
      * Returns an integer describing the backend used by libev.
      *
      * @return int An integer describing the backend used by libev. See Ev::backend().
      */
-    public function backend() {}
+    public function backend()
+    {
+}
 
     /**
      * Creates EvCheck object associated with the current event loop instance.
@@ -1243,7 +1365,9 @@ 
      * @param int $priority
      * @return EvCheck
      */
-    public function check(callable $callback, $data = null, $priority = 0) {}
+    public function check(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates EvChild object associated with the current event loop instance;
@@ -1255,7 +1379,9 @@ 
      * @param int $priority
      * @return EvChild
      */
-    public function child($pid, $trace, callable $callback, $data = null, $priority = 0) {}
+    public function child($pid, $trace, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates EvEmbed object associated with the current event loop instance.
@@ -1266,7 +1392,9 @@ 
      * @param int $priority
      * @return EvEmbed
      */
-    public function embed(EvLoop $other, callable $callback, $data = null, $priority = 0) {}
+    public function embed(EvLoop $other, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates EvFork object associated with the current event loop instance.
@@ -1276,7 +1404,9 @@ 
      * @param int $priority
      * @return EvFork
      */
-    public function fork(callable $callback, $data = null, $priority = 0) {}
+    public function fork(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates EvIdle object associated with the current event loop instance.
@@ -1286,12 +1416,16 @@ 
      * @param int $priority
      * @return EvIdle
      */
-    public function idle(callable $callback, $data = null, $priority = 0) {}
+    public function idle(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Invoke all pending watchers while resetting their pending state.
      */
-    public function invokePending() {}
+    public function invokePending()
+    {
+}
 
     /**
      * Creates EvIo object associated with the current event loop instance.
@@ -1302,7 +1436,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function io($fd, $events, callable $callback, $data = null, $priority = 0) {}
+    public function io($fd, $events, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Must be called after a fork.
@@ -1311,7 +1447,9 @@ 
      * Ev::FLAG_FORKCHECK which calls this function automatically, at some performance loss (refer to the libev
      * documentation).
      */
-    public function loopFork() {}
+    public function loopFork()
+    {
+}
 
     /**
      * Returns the current "event loop time".
@@ -1323,7 +1461,9 @@ 
      *
      * @return double Time of the event loop in (fractional) seconds.
      */
-    public function now() {}
+    public function now()
+    {
+}
 
     /**
      * Establishes the current time by querying the kernel, updating the time returned by Ev::now in the progress.
@@ -1334,7 +1474,9 @@ 
      * This method is rarely useful, but when some event callback runs for a very long time without entering the event
      * loop, updating libev's consideration of the current time is a good idea.
      */
-    public function nowUpdate() {}
+    public function nowUpdate()
+    {
+}
 
     /**
      * Creates EvPeriodic object associated with the current event loop instance.
@@ -1345,7 +1487,9 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function periodic($offset, $interval, callable $callback, $data = null, $priority = 0) {}
+    public function periodic($offset, $interval, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates EvPrepare object associated with the current event loop instance.
@@ -1354,14 +1498,18 @@ 
      * @param mixed $data
      * @param int $priority
      */
-    public function prepare(callable $callback, $data = null, $priority = 0) {}
+    public function prepare(callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Resume previously suspended default event loop.
      *
      * EvLoop::suspend() and EvLoop::resume() methods suspend and resume a loop correspondingly.
      */
-    public function resume() {}
+    public function resume()
+    {
+}
 
     /**
      * Begin checking for events and calling callbacks for the loop.
@@ -1373,7 +1521,9 @@ 
      *
      * @param int $flags One of the Ev::RUN_* flags.
      */
-    public function run($flags = Ev::FLAG_AUTO) {}
+    public function run($flags = Ev::FLAG_AUTO)
+    {
+}
 
     /**
      * Creates EvSignal object associated with the current event loop instance.
@@ -1384,7 +1534,9 @@ 
      * @param int $priority
      * @return EvSignal
      */
-    public function signal($signal, callable $callback, $data = null, $priority = 0) {}
+    public function signal($signal, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Creates EvStats object associated with the current event loop instance.
@@ -1396,21 +1548,27 @@ 
      * @param int $priority
      * @return EvStat
      */
-    public function stat($path, $interval, callable $callback, $data = null, $priority = 0) {}
+    public function stat($path, $interval, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Stops the event loop.
      *
      * @param int $how One of the Ev::BREAK_* flags.
      */
-    public function stop($how = Ev::BREAK_ALL) {}
+    public function stop($how = Ev::BREAK_ALL)
+    {
+}
 
     /**
      * Suspend the loop.
      *
      * EvLoop::suspend() and EvLoop::resume() methods suspend and resume a loop correspondingly.
      */
-    public function suspend() {}
+    public function suspend()
+    {
+}
 
     /**
      * Creates EvTimer object associated with the current event loop instance.
@@ -1422,7 +1580,9 @@ 
      * @param int $priority
      * @return EvTimer
      */
-    public function timer($after, $repeat, callable $callback, $data = null, $priority = 0) {}
+    public function timer($after, $repeat, callable $callback, $data = null, $priority = 0)
+    {
+}
 
     /**
      * Performs internal consistency checks (for debugging).
@@ -1430,7 +1590,9 @@ 
      * Performs internal consistency checks (for debugging libev) and abort the program if any data structures were
      * found to be corrupted.
      */
-    public function verify() {}
+    public function verify()
+    {
+}
 
     /**
      * Returns or creates the default event loop.
@@ -1445,5 +1607,6 @@ 
      */
     public static function defaultLoop(
         $flags = Ev::FLAG_AUTO, $data = null, $io_interval = 0.0, $timeout_interval = 0.0
-    ) {}
+    ) {
+}
 }