PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of Pool.php

(no description)

File Size:	134 lines (5 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Pool:: (4 methods):
  __construct()
  promise()
  batch()
  cmpCallback()

Class: Pool - X-Ref

Sends an iterator of requests concurrently using a capped pool size.

The pool will read from an iterator until it is cancelled or until the
iterator is consumed. When a request is yielded, the request is sent after
applying the "request_options" request options (if provided in the ctor).

When a function is yielded by the iterator, the function is provided the
"request_options" array that should be merged on top of any existing
options, and the function MUST then return a wait-able promise.

__construct(ClientInterface $client,$requests,array $config = []) X-Ref

param: ClientInterface $client Client used to send the requests.
param: array|\Iterator $requests Requests or functions that return
param: array $config Associative array of options

promise() X-Ref

Get promise

return: PromiseInterface

batch(ClientInterface $client,$requests,array $options = []) X-Ref

Sends multiple requests concurrently and returns an array of responses
and exceptions that uses the same ordering as the provided requests.

IMPORTANT: This method keeps every request and response in memory, and
as such, is NOT recommended when sending a large number or an
indeterminate number of requests concurrently.

param: ClientInterface $client Client used to send the requests
param: array|\Iterator $requests Requests to send concurrently.
param: array $options Passes through the options available in
return: array Returns an array containing the response or an exception

cmpCallback(array &$options, $name, array &$results) X-Ref

Execute callback(s)

return: void

PHP Cross Reference of phpBB-3.3.14-deutsch

/vendor/guzzlehttp/guzzle/src/ -> Pool.php (summary)

Defines 1 class