danog/amp
1
0
Fork 0
mirror of https://github.com/danog/amp.git synced 2024-12-11 08:59:46 +01:00
Code Issues Projects Releases Wiki Activity

Define watcher callback signatures

Browse Source
This commit is contained in:
Aaron Piotrowski 2016-05-14 17:14:33 -05:00
parent 38a3da4889
commit 5b283d69e9
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/Loop.php
View File

@ -59,7 +59,7 @@ final class Loop
/** /**
* Defer the execution of a callback. * Defer the execution of a callback.
* *
* @param callable $callback The callback to defer. * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to defer.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -72,7 +72,7 @@ final class Loop
/** /**
* Delay the execution of a callback. The time delay is approximate and accuracy is not guaranteed. * Delay the execution of a callback. The time delay is approximate and accuracy is not guaranteed.
* *
* @param callable $callback The callback to delay. * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to delay.
* @param int $time The amount of time, in milliseconds, to delay the execution for. * @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. * @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. * Repeatedly execute a callback. The interval between executions is approximate and accuracy is not guaranteed.
* *
* @param callable $callback The callback to repeat. * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to repeat.
* @param int $interval The time interval, in milliseconds, to wait between executions. * @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. * @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. * Execute a callback when a stream resource becomes readable.
* *
* @param resource $stream The stream to monitor. * @param resource $stream The stream to monitor.
* @param callable $callback The callback to execute. * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -115,7 +115,7 @@ final class Loop
* Execute a callback when a stream resource becomes writable. * Execute a callback when a stream resource becomes writable.
* *
* @param resource $stream The stream to monitor. * @param resource $stream The stream to monitor.
* @param callable $callback The callback to execute. * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -129,7 +129,7 @@ final class Loop
* Execute a callback when a signal is received. * Execute a callback when a signal is received.
* *
* @param int $signo The signal number to monitor. * @param int $signo The signal number to monitor.
* @param callable $callback The callback to execute. * @param callable(int $signo, mixed $data, string $watcherIdentifier) $callback The callback to execute.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -142,7 +142,7 @@ final class Loop
/** /**
* Execute a callback when an error occurs. * Execute a callback when an error occurs.
* *
* @param callable $callback The callback to execute. * @param callable(\Throwable|\Exception $exception) $callback The callback to execute.
* *
* @return string An identifier that can be used to cancel, enable or disable the event. * @return string An identifier that can be used to cancel, enable or disable the event.
*/ */

14
src/LoopDriver.php
View File

@ -23,7 +23,7 @@ interface LoopDriver
/** /**
* Defer the execution of a callback. * Defer the execution of a callback.
* *
* @param callable $callback The callback to defer. * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to defer.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -33,7 +33,7 @@ interface LoopDriver
/** /**
* Delay the execution of a callback. The time delay is approximate and accuracy is not guaranteed. * Delay the execution of a callback. The time delay is approximate and accuracy is not guaranteed.
* *
* @param callable $callback The callback to delay. * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to delay.
* @param int $delay The amount of time, in milliseconds, to delay the execution for. * @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. * @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. * Repeatedly execute a callback. The interval between executions is approximate and accuracy is not guaranteed.
* *
* @param callable $callback The callback to repeat. * @param callable(mixed $data, string $watcherIdentifier) $callback The callback to repeat.
* @param int $interval The time interval, in milliseconds, to wait between executions. * @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. * @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. * Execute a callback when a stream resource becomes readable.
* *
* @param resource $stream The stream to monitor. * @param resource $stream The stream to monitor.
* @param callable $callback The callback to execute. * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -67,7 +67,7 @@ interface LoopDriver
* Execute a callback when a stream resource becomes writable. * Execute a callback when a stream resource becomes writable.
* *
* @param resource $stream The stream to monitor. * @param resource $stream The stream to monitor.
* @param callable $callback The callback to execute. * @param callable(resource $stream, mixed $data, string $watcherIdentifier) $callback The callback to execute.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -78,7 +78,7 @@ interface LoopDriver
* Execute a callback when a signal is received. * Execute a callback when a signal is received.
* *
* @param int $signo The signal number to monitor. * @param int $signo The signal number to monitor.
* @param callable $callback The callback to execute. * @param callable(int $signo, mixed $data, string $watcherIdentifier) $callback The callback to execute.
* @param mixed $data Arbitrary data given to the callback function as the $data parameter. * @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 event. * @return string An identifier that can be used to cancel, enable or disable the event.
@ -88,7 +88,7 @@ interface LoopDriver
/** /**
* Execute a callback when an error occurs. * Execute a callback when an error occurs.
* *
* @param callable $callback The callback to execute. * @param callable(\Throwable|\Exception $exception) $callback The callback to execute.
* *
* @return string An identifier that can be used to cancel, enable or disable the event. * @return string An identifier that can be used to cancel, enable or disable the event.
*/ */