1
0
mirror of https://github.com/danog/amp.git synced 2024-11-27 12:35:02 +01:00

Merge pull request #112 from async-interop/consistent-docs

Make driver and loop docs consistent
This commit is contained in:
Bob Weinand 2016-11-14 17:58:06 +01:00 committed by GitHub
commit ef913fcfbb

View File

@ -55,6 +55,10 @@ final class Loop
/**
* Execute a callback within the scope of an event loop driver.
*
* The loop MUST continue to run until it is either stopped explicitly, no referenced watchers exist anymore, or an
* exception is thrown that cannot be handled. Exceptions that cannot be handled are exceptions thrown from an
* error handler or exceptions that would be passed to an error handler but none exists to handle them.
*
* @param callable $callback The callback to execute.
* @param Driver $driver The event loop driver. If `null`, a new one is created from the set factory.
*
@ -118,6 +122,9 @@ final class Loop
/**
* Stop the event loop.
*
* When an event loop is stopped, it continues with its current tick and exits the loop afterwards. Multiple calls
* to stop MUST be ignored and MUST NOT raise an exception.
*
* @return void
*/
public static function stop()