TaskQueue

class Firstred\PostNL\Util\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.

queue()->run();

Summary

Methods

Properties

private static property Firstred\PostNL\Util\TaskQueue::$enableShutdown
private static property Firstred\PostNL\Util\TaskQueue::$queue

Methods

public Firstred\PostNL\Util\TaskQueue::__construct($withShutdown=true)
TaskQueue constructor.
Parameters:
  • $withShutdown (bool)

public Firstred\PostNL\Util\TaskQueue::isEmpty()
Returns:

bool

public Firstred\PostNL\Util\TaskQueue::add($task)
Parameters:
  • $task (callable)

public Firstred\PostNL\Util\TaskQueue::run()
Returns:

void

public Firstred\PostNL\Util\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.