[ Index ]

PHP Cross Reference of phpBB-3.3.7-deutsch

title

Body

[close]

/vendor/guzzlehttp/promises/src/ -> functions.php (summary)

(no description)

File Size: 363 lines (10 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 20 functions

  queue()
  task()
  promise_for()
  rejection_for()
  exception_for()
  iter_for()
  inspect()
  inspect_all()
  unwrap()
  all()
  some()
  any()
  settle()
  each()
  each_limit()
  each_limit_all()
  is_fulfilled()
  is_rejected()
  is_settled()
  coroutine()

Functions
Functions that are not part of a class:

queue(TaskQueueInterface $assign = null)   X-Ref
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.

<code>
while ($eventLoop->isRunning()) {
GuzzleHttp\Promise\queue()->run();
}
</code>

param: TaskQueueInterface $assign Optionally specify a new queue instance.
return: TaskQueueInterface

task(callable $task)   X-Ref
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.

param: callable $task Task function to run.
return: PromiseInterface

promise_for($value)   X-Ref
Creates a promise for a value if the value is not a promise.

param: mixed $value Promise or value.
return: PromiseInterface

rejection_for($reason)   X-Ref
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.

param: mixed $reason Promise or reason.
return: PromiseInterface

exception_for($reason)   X-Ref
Create an exception for a rejected promise value.

param: mixed $reason
return: \Exception|\Throwable

iter_for($value)   X-Ref
Returns an iterator for the given value.

param: mixed $value
return: \Iterator

inspect(PromiseInterface $promise)   X-Ref
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.

param: PromiseInterface $promise Promise or value.
return: array

inspect_all($promises)   X-Ref
Waits on all of the provided promises, but does not unwrap rejected promises
as thrown exception.

Returns an array of inspection state arrays.

param: PromiseInterface[] $promises Traversable of promises to wait upon.
return: array

unwrap($promises)   X-Ref
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.

param: iterable<PromiseInterface> $promises Iterable of PromiseInterface objects to wait on.
return: array

all($promises, $recursive = false)   X-Ref
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.

param: mixed $promises  Promises or values.
param: bool  $recursive If true, resolves new promises that might have been added to the stack during its own resolution.
return: PromiseInterface

some($count, $promises)   X-Ref
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 promise is rejected with a {@see AggregateException} if the number of
fulfilled promises is less than the desired $count.

param: int   $count    Total number of promises.
param: mixed $promises Promises or values.
return: PromiseInterface

any($promises)   X-Ref
Like some(), with 1 as count. However, if the promise fulfills, the
fulfillment value is not an array of 1 but the value directly.

param: mixed $promises Promises or values.
return: PromiseInterface

settle($promises)   X-Ref
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.

param: mixed $promises Promises or values.
return: PromiseInterface

each($iterable,callable $onFulfilled = null,callable $onRejected = null)   X-Ref
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 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 if needed.

param: mixed    $iterable    Iterator or array to iterate over.
param: callable $onFulfilled
param: callable $onRejected
return: PromiseInterface

each_limit($iterable,$concurrency,callable $onFulfilled = null,callable $onRejected = null)   X-Ref
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.

param: mixed        $iterable
param: int|callable $concurrency
param: callable     $onFulfilled
param: callable     $onRejected
return: PromiseInterface

each_limit_all($iterable,$concurrency,callable $onFulfilled = null)   X-Ref
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.

param: mixed        $iterable
param: int|callable $concurrency
param: callable     $onFulfilled
return: PromiseInterface

is_fulfilled(PromiseInterface $promise)   X-Ref
Returns true if a promise is fulfilled.

return: bool

is_rejected(PromiseInterface $promise)   X-Ref
Returns true if a promise is rejected.

return: bool

is_settled(PromiseInterface $promise)   X-Ref
Returns true if a promise is fulfilled or rejected.

return: bool

coroutine(callable $generatorFn)   X-Ref
Create a new coroutine.

return: PromiseInterface



Generated: Thu Mar 24 21:31:15 2022 Cross-referenced by PHPXref 0.7.1