| PromiseInterface | A promise represents the eventual result of an asynchronous operation. |
| PromisorInterface | Interface used with classes that return a promise. |
| TaskQueueInterface |
| AggregateException | Exception thrown when too many errors occur in the some() or any() methods. |
| CancellationException | Exception that is set as the reason for a promise that has been cancelled. |
| Coroutine | Creates a promise that is resolved using a generator that yields values or promises (somewhat similar to C#'s async keyword). |
| EachPromise | Represents a promise that iterates over many promises and invokes side-effect functions in the process. |
| FulfilledPromise | A promise that has been fulfilled. |
| Promise | Promises/A+ implementation that avoids recursion when possible. |
| RejectedPromise | A promise that has been rejected. |
| RejectionException | A special exception that is thrown when waiting on a rejected promise. |
| TaskQueue | A task queue that executes tasks in a FIFO order. |
all(mixed $promises) : \GuzzleHttp\Promise\PromiseInterface
Given an array of promises, return a promise that is fulfilled when all the items in the array are fulfilled.
The promise's fulfillment value is an array with fulfillment values at respective positions to the original array. If any promise in the array rejects, the returned promise is rejected with the rejection reason.
| mixed | $promises | Promises or values. |
any(mixed $promises) : \GuzzleHttp\Promise\PromiseInterface
Like some(), with 1 as count. However, if the promise fulfills, the fulfillment value is not an array of 1 but the value directly.
| mixed | $promises | Promises or values. |
coroutine(callable $generatorFn) : \GuzzleHttp\Promise\PromiseInterface
| callable | $generatorFn |
each(mixed $iterable, callable $onFulfilled = null, callable $onRejected = null) : \GuzzleHttp\Promise\PromiseInterface
Given an iterator that yields promises or values, returns a promise that is fulfilled with a null value when the iterator has been consumed or the aggregate promise has been fulfilled or rejected.
$onFulfilled is a function that accepts the fulfilled value, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate promise if needed.
$onRejected is a function that accepts the rejection reason, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate promise if needed.
| mixed | $iterable | Iterator or array to iterate over. |
| callable | $onFulfilled | |
| callable | $onRejected |
each_limit(mixed $iterable, integer|callable $concurrency, callable $onFulfilled = null, callable $onRejected = null) : \GuzzleHttp\Promise\PromiseInterface
Like each, but only allows a certain number of outstanding promises at any given time.
$concurrency may be an integer or a function that accepts the number of pending promises and returns a numeric concurrency limit value to allow for dynamic a concurrency size.
| mixed | $iterable | |
| integer|callable | $concurrency | |
| callable | $onFulfilled | |
| callable | $onRejected |
each_limit_all(mixed $iterable, integer|callable $concurrency, callable $onFulfilled = null) : \GuzzleHttp\Promise\PromiseInterface
Like each_limit, but ensures that no promise in the given $iterable argument is rejected. If any promise is rejected, then the aggregate promise is rejected with the encountered rejection.
| mixed | $iterable | |
| integer|callable | $concurrency | |
| callable | $onFulfilled |
inspect(\GuzzleHttp\Promise\PromiseInterface $promise) : array
Synchronously waits on a promise to resolve and returns an inspection state array.
Returns a state associative array containing a "state" key mapping to a valid promise state. If the state of the promise is "fulfilled", the array will contain a "value" key mapping to the fulfilled value of the promise. If the promise is rejected, the array will contain a "reason" key mapping to the rejection reason of the promise.
| \GuzzleHttp\Promise\PromiseInterface | $promise | Promise or value. |
inspect_all(array<mixed,\GuzzleHttp\Promise\PromiseInterface> $promises) : array
Waits on all of the provided promises, but does not unwrap rejected promises as thrown exception.
Returns an array of inspection state arrays.
| array<mixed,\GuzzleHttp\Promise\PromiseInterface> | $promises | Traversable of promises to wait upon. |
is_fulfilled(\GuzzleHttp\Promise\PromiseInterface $promise) : boolean
Returns true if a promise is fulfilled.
| \GuzzleHttp\Promise\PromiseInterface | $promise |
is_rejected(\GuzzleHttp\Promise\PromiseInterface $promise) : boolean
Returns true if a promise is rejected.
| \GuzzleHttp\Promise\PromiseInterface | $promise |
is_settled(\GuzzleHttp\Promise\PromiseInterface $promise) : boolean
Returns true if a promise is fulfilled or rejected.
| \GuzzleHttp\Promise\PromiseInterface | $promise |
promise_for(mixed $value) : \GuzzleHttp\Promise\PromiseInterface
Creates a promise for a value if the value is not a promise.
| mixed | $value | Promise or value. |
queue(\GuzzleHttp\Promise\TaskQueueInterface $assign = null) : \GuzzleHttp\Promise\TaskQueueInterface
Get the global task queue used for promise resolution.
This task queue MUST be run in an event loop in order for promises to be settled asynchronously. It will be automatically run when synchronously waiting on a promise.
while ($eventLoop->isRunning()) {
GuzzleHttp\Promise\queue()->run();
}
| \GuzzleHttp\Promise\TaskQueueInterface | $assign | Optionally specify a new queue instance. |
rejection_for(mixed $reason) : \GuzzleHttp\Promise\PromiseInterface
Creates a rejected promise for a reason if the reason is not a promise. If the provided reason is a promise, then it is returned as-is.
| mixed | $reason | Promise or reason. |
settle(mixed $promises) : \GuzzleHttp\Promise\PromiseInterface
Returns a promise that is fulfilled when all of the provided promises have been fulfilled or rejected.
The returned promise is fulfilled with an array of inspection state arrays.
| mixed | $promises | Promises or values. |
some(integer $count, mixed $promises) : \GuzzleHttp\Promise\PromiseInterface
Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises).
When count amount of promises have been fulfilled, the returned promise is fulfilled with an array that contains the fulfillment values of the winners in order of resolution.
This prommise is rejected with a \GuzzleHttp\Promise\GuzzleHttp\Promise\AggregateException if the number of fulfilled promises is less than the desired $count.
| integer | $count | Total number of promises. |
| mixed | $promises | Promises or values. |
task(callable $task) : \GuzzleHttp\Promise\PromiseInterface
Adds a function to run in the task queue when it is next `run()` and returns a promise that is fulfilled or rejected with the result.
| callable | $task | Task function to run. |
unwrap(mixed $promises) : array
Waits on all of the provided promises and returns the fulfilled values.
Returns an array that contains the value of each promise (in the same order the promises were provided). An exception is thrown if any of the promises are rejected.
| mixed | $promises | Iterable of PromiseInterface objects to wait on. |
on error
on error in PHP >=7