Public Member Functions | |
| __construct ($step=1) | |
| makesDecision () | |
 Public Member Functions inherited from Guzzle\Plugin\Backoff\AbstractBackoffStrategy | |
| getBackoffPeriod ( $retries, RequestInterface $request, Response $response=null, HttpException $e=null) | |
| getNext () | |
| setNext (AbstractBackoffStrategy $next) | |
Protected Member Functions | |
| getDelay ($retries, RequestInterface $request, Response $response=null, HttpException $e=null) | |
Protected Attributes | |
| $step | |
| Protected Attributes inherited from Guzzle\Plugin\Backoff\AbstractBackoffStrategy | |
| $next | |
Detailed Description
Implements a linear backoff retry strategy.
Warning: If no decision making strategies precede this strategy in the the chain, then all requests will be retried
Definition at line 14 of file LinearBackoffStrategy.php.
Constructor & Destructor Documentation
◆ __construct()
| Guzzle\Plugin\Backoff\LinearBackoffStrategy::__construct | ( | $step = 1 | ) |
- Parameters
-
int $step Amount of time to increase the delay each additional backoff
Definition at line 25 of file LinearBackoffStrategy.php.
References Guzzle\Plugin\Backoff\LinearBackoffStrategy\$step.
Member Function Documentation
◆ getDelay()
|
protected |
Implement the concrete strategy
- 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|null Returns false to not retry or the number of seconds to delay between retries. Return true or null to defer to the next strategy if available, and if not, return 0.
Reimplemented from Guzzle\Plugin\Backoff\AbstractBackoffStrategy.
Definition at line 35 of file LinearBackoffStrategy.php.
References Guzzle\Plugin\Backoff\LinearBackoffStrategy\$step.
◆ makesDecision()
| Guzzle\Plugin\Backoff\LinearBackoffStrategy::makesDecision | ( | ) |
Check if the strategy does filtering and makes decisions on whether or not to retry.
Strategies that return false will never retry if all of the previous strategies in a chain defer on a backoff decision.
- Returns
- bool
Reimplemented from Guzzle\Plugin\Backoff\AbstractBackoffStrategy.
Definition at line 30 of file LinearBackoffStrategy.php.
Field Documentation
◆ $step
|
protected |
Amount of time to progress each delay
Definition at line 20 of file LinearBackoffStrategy.php.
Referenced by Guzzle\Plugin\Backoff\LinearBackoffStrategy\__construct(), and Guzzle\Plugin\Backoff\LinearBackoffStrategy\getDelay().
The documentation for this class was generated from the following file:
