Guzzle\Plugin\Backoff\BackoffStrategyInterface Interface Reference
Inheritance diagram for Guzzle\Plugin\Backoff\BackoffStrategyInterface:
Public Member Functions | |
| getBackoffPeriod ( $retries, RequestInterface $request, Response $response=null, HttpException $e=null) | |
Detailed Description
Strategy to determine if a request should be retried and how long to delay between retries
Definition at line 12 of file BackoffStrategyInterface.php.
Member Function Documentation
◆ getBackoffPeriod()
| Guzzle\Plugin\Backoff\BackoffStrategyInterface::getBackoffPeriod | ( | $retries, | |
| RequestInterface | $request, | ||
| Response | $response = null, |
||
| HttpException | $e = null |
||
| ) |
Get the amount of time to delay in seconds before retrying a request
- Parameters
-
int $retries Number of retries of the request RequestInterface $request Request that was sent Response $response Response that was received. Note that there may not be a response HttpException $e Exception that was encountered if any
- Returns
- bool|int Returns false to not retry or the number of seconds to delay between retries
Implemented in Guzzle\Plugin\Backoff\AbstractBackoffStrategy.
The documentation for this interface was generated from the following file:
