\GuzzleHttp\PromiseTaskQueue

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\queue()->run();

Summary

Methods
Properties
Constants
__construct()
isEmpty()
add()
run()
disableShutdown()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$enableShutdown
$queue
N/A

Properties

$enableShutdown

$enableShutdown : 

Type

$queue

$queue : 

Type

Methods

__construct()

__construct(  $withShutdown = true) 

Parameters

$withShutdown

isEmpty()

isEmpty() : boolean

Returns true if the queue is empty.

Returns

boolean

add()

add(callable  $task) 

Adds a task to the queue that will be executed the next time run is called.

Parameters

callable $task

run()

run() 

Execute all of the pending task in the queue.

disableShutdown()

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.