ThrottlingHttpClient
in package
implements
HttpClientInterface, ResetInterface
uses
DecoratorTrait
Limits the number of requests within a certain period.
Table of Contents
Interfaces
- HttpClientInterface
- Provides flexible methods for requesting HTTP resources synchronously or asynchronously.
- ResetInterface
- Provides a way to reset an object to its initial state.
Properties
- $client : HttpClientInterface
- $rateLimiter : LimiterInterface
Methods
- __construct() : mixed
- request() : ResponseInterface
- Requests an HTTP resource.
- reset() : void
- stream() : ResponseStreamInterface
- withOptions() : static
Properties
$client
private
HttpClientInterface
$client
$rateLimiter read-only
private
LimiterInterface
$rateLimiter
Methods
__construct()
public
__construct(HttpClientInterface $client, LimiterInterface $rateLimiter) : mixed
Parameters
- $client : HttpClientInterface
- $rateLimiter : LimiterInterface
request()
Requests an HTTP resource.
public
request(string $method, string $url[, array<string|int, mixed> $options = [] ]) : ResponseInterface
Responses MUST be lazy, but their status code MUST be checked even if none of their public methods are called.
Implementations are not required to support all options described above; they can also support more custom options; but in any case, they MUST throw a TransportExceptionInterface when an unsupported option is passed.
Parameters
- $method : string
- $url : string
- $options : array<string|int, mixed> = []
Return values
ResponseInterfacereset()
public
reset() : void
stream()
public
stream(ResponseInterface|iterable<string|int, mixed> $responses[, float|null $timeout = null ]) : ResponseStreamInterface
Parameters
- $responses : ResponseInterface|iterable<string|int, mixed>
- $timeout : float|null = null
Return values
ResponseStreamInterfacewithOptions()
public
withOptions(array<string|int, mixed> $options) : static
Parameters
- $options : array<string|int, mixed>