Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mnapoli committed May 30, 2014
1 parent d0e0e21 commit ea2904b
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,18 @@ interface SynchronousWorkDispatcher extends WorkDispatcher
* Run a task in background.
*
* You can use $wait to wait a given time for the task to complete.
* If the task hasn't finished during this time, $timedout will be called and this method will return.
* If the task hasn't finished during this time, $timedout will be
* called and this method will return.
* If the task has finished, $completed will be called.
*
* @param Task $task
* @param int $wait Number of seconds to wait for the task to complete. If 0, doesn't wait.
* @param int $wait Number of seconds to wait for the task to complete.
* If 0, doesn't wait.
* @param callable $completed Called (if $wait > 0) when the task has completed.
* @param callable $timedout Called (if $wait > 0) if we hit the timeout while waiting.
* @param callable $errored Called (if $wait > 0) if the task errors. Takes 1 parameter which is the exception.
* @param callable $timedout Called (if $wait > 0) if we hit the timeout while
* waiting.
* @param callable $errored Called (if $wait > 0) if the task errors. Takes 1
* parameter which is the exception.
*
* @return void No results
*/
Expand Down

0 comments on commit ea2904b

Please sign in to comment.