Overview

Namespaces

  • Docta
    • MercadoLibre
      • Exception
      • OAuth2
        • Client
          • Test
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
      • Test
      • Tests
    • Psr7
    • Test
      • Handler
    • Tests
      • CookieJar
      • Event
      • Exception
      • Handler
      • Promise
      • Psr7
  • League
    • OAuth2
      • Client
        • Grant
          • Exception
        • Provider
          • Exception
        • Test
          • Grant
          • Provider
            • Exception
            • Fake
          • Token
          • Tool
        • Token
        • Tool
  • None
  • Psr
    • Http
      • Message

Classes

  • Client
  • HandlerStack
  • MessageFormatter
  • Middleware
  • Pool
  • PrepareBodyMiddleware
  • RedirectMiddleware
  • RequestOptions
  • RetryMiddleware
  • TransferStats
  • UriTemplate

Interfaces

  • ClientInterface

Functions

  • choose_handler
  • debug_resource
  • default_ca_bundle
  • default_user_agent
  • describe_type
  • headers_from_lines
  • is_host_in_noproxy
  • json_decode
  • json_encode
  • normalize_header_keys
  • uri_template
  • Overview
  • Namespace
  • Class
  • Download

Class Pool

Sends and 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.

GuzzleHttp\Pool implements GuzzleHttp\Promise\PromisorInterface
Namespace: GuzzleHttp
Located at src/Pool.php
Methods summary
public
# __construct( GuzzleHttp\ClientInterface $client, array|Iterator $requests, array $config = [] )

Parameters

$client
Client used to send the requests.
$requests

Requests or functions that return requests to send concurrently.

$config

Associative array of options - concurrency: (int) Maximum number of requests to send concurrently - options: Array of request options to apply to each request. - fulfilled: (callable) Function to invoke when a request completes. - rejected: (callable) Function to invoke when a request is rejected.

public PromiseInterface
# promise( )

Returns a promise.

Returns a promise.

Returns

PromiseInterface

Implementation of

GuzzleHttp\Promise\PromisorInterface::promise()
public static array
# batch( GuzzleHttp\ClientInterface $client, array|Iterator $requests, array $options = [] )

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

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.

Parameters

$client
Client used to send the requests
$requests
Requests to send concurrently.
$options

Passes through the options available in GuzzleHttp\Pool::__construct

Returns

array

Returns an array containing the response or an exception in the same order that the requests were sent.

Throws

InvalidArgumentException
if the event format is incorrect.
MercadoLibre PHP SDK API documentation generated by ApiGen