RetryMiddleware
in package
Middleware that retries requests based on the boolean result of invoking the provided "decider" function.
Tags
Table of Contents
- $decider : callable
- $delay : callable|(int)
- $nextHandler : mixed
- __construct() : mixed
- __invoke() : PromiseInterface
- exponentialDelay() : int
- Default exponential backoff delay function.
- doRetry() : PromiseInterface
- onFulfilled() : callable
- Execute fulfilled closure
- onRejected() : callable
- Execute rejected closure
Properties
$decider
private
callable
$decider
$delay
private
callable|(int)
$delay
$nextHandler
private
mixed
$nextHandler
callable(RequestInterface, array): PromiseInterface
Methods
__construct()
public
__construct(callable $decider, callable $nextHandler[, callable $delay = null ]) : mixed
Parameters
- $decider : callable
-
Function that accepts the number of retries, a request, [response], and [exception] and returns true if the request is to be retried.
- $nextHandler : callable
- $delay : callable = null
Return values
mixed —__invoke()
public
__invoke(RequestInterface $request, array<string|int, mixed> $options) : PromiseInterface
Parameters
- $request : RequestInterface
- $options : array<string|int, mixed>
Return values
PromiseInterface —exponentialDelay()
Default exponential backoff delay function.
public
static exponentialDelay(int $retries) : int
Parameters
- $retries : int
Return values
int —milliseconds.
doRetry()
private
doRetry(RequestInterface $request, array<string|int, mixed> $options[, ResponseInterface $response = null ]) : PromiseInterface
Parameters
- $request : RequestInterface
- $options : array<string|int, mixed>
- $response : ResponseInterface = null
Return values
PromiseInterface —onFulfilled()
Execute fulfilled closure
private
onFulfilled(RequestInterface $request, array<string|int, mixed> $options) : callable
Parameters
- $request : RequestInterface
- $options : array<string|int, mixed>
Return values
callable —onRejected()
Execute rejected closure
private
onRejected(RequestInterface $req, array<string|int, mixed> $options) : callable
Parameters
- $req : RequestInterface
- $options : array<string|int, mixed>