Class TaskQueue
- GuzzleHttp\Promise\TaskQueue implements GuzzleHttp\Promise\TaskQueueInterface
- Namespace: GuzzleHttp\Promise
- Located at TaskQueue.php
A task queue that executes tasks in a FIFO order.
This task queue class is used to settle promises asynchronously and
maintains a constant stack size. You can use the task queue asynchronously
by calling the run()
function of the global task queue in an event loop.
GuzzleHttp\Promise\Utils::queue()->run();
Methods Summary
- __construct ( $withShutdown = true )
-
isEmpty ( )
Returns true if the queue is empty.
-
add ( callable $task )
Adds a task to the queue that will be executed the next time run is called.
-
run ( )
Execute all of the pending task in the queue.
-
disableShutdown ( )
The task queue will be run and exhausted by default when the process exits IFF the exit is not the result of a PHP E_ERROR error.
Methods Details
__construct ( $withShutdown = true )
boolean isEmpty ( )
Returns true if the queue is empty.
Returns
boolean |
Implementation of
add ( callable $task )
Adds a task to the queue that will be executed the next time run is called.
Implementation of
run ( )
Execute all of the pending task in the queue.
Implementation of
disableShutdown ( )
The task queue will be run and exhausted by default when the process exits IFF the exit is not the result of a PHP E_ERROR error.
You can disable running the automatic shutdown of the queue by calling this function. If you disable the task queue shutdown process, then you MUST either run the task queue (as a result of running your event loop or manually using the run() method) or wait on each outstanding promise.
Note: This shutdown will occur before any destructors are triggered.