From ffde57f0d14602553ae55606848c346f34a0f8bd Mon Sep 17 00:00:00 2001 From: Aaron Piotrowski Date: Thu, 19 May 2016 10:21:26 -0500 Subject: [PATCH] Make watcher ID first parameter --- src/Loop.php | 42 +++++++++++++++++++++--------------------- src/LoopDriver.php | 32 ++++++++++++++++---------------- 2 files changed, 37 insertions(+), 37 deletions(-) diff --git a/src/Loop.php b/src/Loop.php index d803f87..66b3c8c 100644 --- a/src/Loop.php +++ b/src/Loop.php @@ -59,7 +59,7 @@ final class Loop /** * Defer the execution of a callback. * - * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to defer. + * @param callable(string $watcherId, mixed $data) $callback The callback to defer. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -72,7 +72,7 @@ final class Loop /** * Delay the execution of a callback. The time delay is approximate and accuracy is not guaranteed. * - * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to delay. + * @param callable(string $watcherId, mixed $data) $callback The callback to delay. * @param int $time The amount of time, in milliseconds, to delay the execution for. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @@ -86,7 +86,7 @@ final class Loop /** * Repeatedly execute a callback. The interval between executions is approximate and accuracy is not guaranteed. * - * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to repeat. + * @param callable(string $watcherId, mixed $data) $callback The callback to repeat. * @param int $interval The time interval, in milliseconds, to wait between executions. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @@ -101,7 +101,7 @@ final class Loop * Execute a callback when a stream resource becomes readable. * * @param resource $stream The stream to monitor. - * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute. + * @param callable(string $watcherId, resource $stream, mixed $data) $callback The callback to execute. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -115,7 +115,7 @@ final class Loop * Execute a callback when a stream resource becomes writable. * * @param resource $stream The stream to monitor. - * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute. + * @param callable(string $watcherId, resource $stream, mixed $data) $callback The callback to execute. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -129,7 +129,7 @@ final class Loop * Execute a callback when a signal is received. * * @param int $signo The signal number to monitor. - * @param callable(int $signo, mixed $data, string $watcherIdentifier) $callback The callback to execute. + * @param callable(string $watcherId, int $signo, mixed $data) $callback The callback to execute. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -154,37 +154,37 @@ final class Loop /** * Enable a watcher. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public static function enable($watcherIdentifier) + public static function enable($watcherId) { - self::get()->enable($watcherIdentifier); + self::get()->enable($watcherId); } /** * Disable a watcher. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public static function disable($watcherIdentifier) + public static function disable($watcherId) { - self::get()->disable($watcherIdentifier); + self::get()->disable($watcherId); } /** * Cancel a watcher. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public static function cancel($watcherIdentifier) + public static function cancel($watcherId) { - self::get()->cancel($watcherIdentifier); + self::get()->cancel($watcherId); } /** @@ -193,13 +193,13 @@ final class Loop * This will keep the event loop alive whilst the event is still being monitored. Watchers have this state by * default. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public static function reference($watcherIdentifier) + public static function reference($watcherId) { - self::get()->reference($watcherIdentifier); + self::get()->reference($watcherId); } /** @@ -208,13 +208,13 @@ final class Loop * The event loop should exit the run method when only unreferenced watchers are still being monitored. Events are * all referenced by default. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public static function unreference($watcherIdentifier) + public static function unreference($watcherId) { - self::get()->unreference($watcherIdentifier); + self::get()->unreference($watcherId); } /** diff --git a/src/LoopDriver.php b/src/LoopDriver.php index a819b47..eeca1cc 100644 --- a/src/LoopDriver.php +++ b/src/LoopDriver.php @@ -23,7 +23,7 @@ interface LoopDriver /** * Defer the execution of a callback. * - * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to defer. + * @param callable(string $watcherId, mixed $data) $callback The callback to defer. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -33,7 +33,7 @@ interface LoopDriver /** * Delay the execution of a callback. The time delay is approximate and accuracy is not guaranteed. * - * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to delay. + * @param callable(string $watcherId, mixed $data) $callback The callback to delay. * @param int $delay The amount of time, in milliseconds, to delay the execution for. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @@ -44,7 +44,7 @@ interface LoopDriver /** * Repeatedly execute a callback. The interval between executions is approximate and accuracy is not guaranteed. * - * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to repeat. + * @param callable(string $watcherId, mixed $data) $callback The callback to repeat. * @param int $interval The time interval, in milliseconds, to wait between executions. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @@ -56,7 +56,7 @@ interface LoopDriver * Execute a callback when a stream resource becomes readable. * * @param resource $stream The stream to monitor. - * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute. + * @param callable(string $watcherId, resource $stream, mixed $data) $callback The callback to execute. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -67,7 +67,7 @@ interface LoopDriver * Execute a callback when a stream resource becomes writable. * * @param resource $stream The stream to monitor. - * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute. + * @param callable(string $watcherId, resource $stream, mixed $data) $callback The callback to execute. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -78,7 +78,7 @@ interface LoopDriver * Execute a callback when a signal is received. * * @param int $signo The signal number to monitor. - * @param callable(int $signo, mixed $data, string $watcherIdentifier) $callback The callback to execute. + * @param callable(string $watcherId, int $signo, mixed $data) $callback The callback to execute. * @param mixed $data Arbitrary data given to the callback function as the $data parameter. * * @return string An identifier that can be used to cancel, enable or disable the watcher. @@ -97,40 +97,40 @@ interface LoopDriver /** * Enable a watcher. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public function enable($watcherIdentifier); + public function enable($watcherId); /** * Disable a watcher. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public function disable($watcherIdentifier); + public function disable($watcherId); /** * Cancel a watcher. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public function cancel($watcherIdentifier); + public function cancel($watcherId); /** * Reference a watcher. * * This will keep the event loop alive whilst the event is still being monitored. Events have this state by default. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public function reference($watcherIdentifier); + public function reference($watcherId); /** * Unreference a watcher. @@ -138,11 +138,11 @@ interface LoopDriver * The event loop should exit the run method when only unreferenced events are still being monitored. Events are all * referenced by default. * - * @param string $watcherIdentifier The watcher identifier. + * @param string $watcherId The watcher identifier. * * @return void */ - public function unreference($watcherIdentifier); + public function unreference($watcherId); /** * Check whether an optional features is supported by this implementation