class TaskQueue

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();

@final

Hierarchy

class \GuzzleHttp\Promise\TaskQueue implements \GuzzleHttp\Promise\TaskQueueInterface

Expanded class hierarchy of TaskQueue

File

vendor/guzzlehttp/promises/src/TaskQueue.php, line 18

Namespace

GuzzleHttp\Promise

View source

class TaskQueue implements TaskQueueInterface {
    private $enableShutdown = true;
    private $queue = [];
    public function __construct(bool $withShutdown = true) {
        if ($withShutdown) {
            register_shutdown_function(function () : void {
                if ($this->enableShutdown) {
                    // Only run the tasks if an E_ERROR didn't occur.
                    $err = error_get_last();
                    if (!$err || $err['type'] ^ E_ERROR) {
                        $this->run();
                    }
                }
            });
        }
    }
    public function isEmpty() : bool {
        return !$this->queue;
    }
    public function add(callable $task) : void {
        $this->queue[] = $task;
    }
    public function run() : void {
        while ($task = array_shift($this->queue)) {
            
            /** @var callable $task */
            $task();
        }
    }
    
    /**
     * 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.
     */
    public function disableShutdown() : void {
        $this->enableShutdown = false;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
TaskQueue::$enableShutdown	private	property
TaskQueue::$queue	private	property
TaskQueue::add	public	function	Adds a task to the queue that will be executed the next time run is called.	Overrides TaskQueueInterface::add
TaskQueue::disableShutdown	public	function	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.
TaskQueue::isEmpty	public	function	Returns true if the queue is empty.	Overrides TaskQueueInterface::isEmpty
TaskQueue::run	public	function	Execute all of the pending task in the queue.	Overrides TaskQueueInterface::run
TaskQueue::__construct	public	function