Overview

Namespaces

  • Baguette
    • Mastodon
      • Config
      • Entity
      • Grant
      • Service
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
  • Psr
    • Http
      • Message
  • Teto
    • Object

Classes

  • Coroutine
  • EachPromise
  • FulfilledPromise
  • Promise
  • RejectedPromise
  • TaskQueue

Interfaces

  • PromiseInterface
  • PromisorInterface
  • TaskQueueInterface

Exceptions

  • AggregateException
  • CancellationException
  • RejectionException

Functions

  • all
  • any
  • coroutine
  • each
  • each_limit
  • each_limit_all
  • exception_for
  • inspect
  • inspect_all
  • is_fulfilled
  • is_rejected
  • is_settled
  • iter_for
  • promise_for
  • queue
  • rejection_for
  • settle
  • some
  • task
  • unwrap
  • Overview
  • Namespace
  • Class

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

GuzzleHttp\Promise\TaskQueue implements GuzzleHttp\Promise\TaskQueueInterface
Namespace: GuzzleHttp\Promise
Located at TaskQueue.php
Methods summary
public
# __construct( $withShutdown = true )
public boolean
# isEmpty( )

Returns true if the queue is empty.

Returns true if the queue is empty.

Returns

boolean

Implementation of

GuzzleHttp\Promise\TaskQueueInterface::isEmpty()
public
# add( callable $task )

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

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

Parameters

$task

Implementation of

GuzzleHttp\Promise\TaskQueueInterface::add()
public
# run( )

Execute all of the pending task in the queue.

Execute all of the pending task in the queue.

Implementation of

GuzzleHttp\Promise\TaskQueueInterface::run()
public
# 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.

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.

ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by ApiGen