Download the PHP package yriveiro/php-backoff without Composer
On this page you can find all versions of the php package yriveiro/php-backoff. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yriveiro/php-backoff
More information about yriveiro/php-backoff
Files in yriveiro/php-backoff
Package php-backoff
Short Description Simple backoff / retry functionality
License MIT
Rated 5.00 based on 1 reviews
Informations about the package php-backoff
Backoff, Simple backoff / retry functionality
NOTE: to use php-backoff with PHP 5.x please use the lastet release of branch 1.x
API
getDefaultOptions():
This method is static and returns an array with the default options:
cap
: Max duration allowed (in microseconds). If backoff duration is greater than cap, cap is returned, default is1000000
microseconds.maxAttempts
: Number of attempts before thrown an Yriveiro\Backoff\BackoffException. Default is0
, no limit.
exponential($attempt):
This method use and exponential function E(attempt) = (2**attempt - 1)
to calculate backoff time.
Parameters
attempt
: incremental value that represents the current retry number.
equalJitter($attempt);
Exponential backoff has one disadvantage. In high concurrence, we can have multiples calls with the same backoff time due the time is highly bound to the current attempt, different calls could be in the same attempt.
To solve this we can add a jitter value to allow some randomization.
equalJitter
uses the function: E(attempt) = min(((2**attempt - 1) / 2), random(0, ((2**attempt - 1) / 2)))
.
Parameters
attempt
: incremental value that represents the current retry number.
fullJitter($attempt);
Full jitter behaves like equalJitter
method, the main difference between them is the way in how the jitter value is calculated.
fullJitter
uses the function: E(attempt) = min(random(0, (2**attempt - 1) / 2))
.
Parameters
attempt
: incremental value that represents the current retry number.
Usage
Zero configuration examples:
With zero configuration, we will never stop to try fetch data. The exit condition is your responsibility.
With configuration examples:
Installation
The recommended way to install this package is through Composer.
Tests
Tests are performed using the phpunit
library, to run them:
Know issues
None.
How to contribute
Have an idea? Found a bug?, contributions are welcome :)
License
Backoff is licensed under MIT license.