Inheritance diagram for GuzzleHttp\Promise\TaskQueue:

Public Member Functions
	__construct ($withShutdown=true)

	add (callable $task)

	disableShutdown ()

	isEmpty ()

	run ()

Detailed Description

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

Definition at line 13 of file TaskQueue.php.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Promise\TaskQueue::__construct ( $withShutdown = true )

Definition at line 18 of file TaskQueue.php.

References GuzzleHttp\Promise\TaskQueue\run().

Member Function Documentation

◆ add()

GuzzleHttp\Promise\TaskQueue::add ( callable $task )

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

Parameters

callable $task

Implements GuzzleHttp\Promise\TaskQueueInterface.

Definition at line 38 of file TaskQueue.php.

References GuzzleHttp\Promise\queue().

◆ disableShutdown()

GuzzleHttp\Promise\TaskQueue::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.

Definition at line 62 of file TaskQueue.php.