Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patinthehat/backoffv2
PHP library implementing various backoff alforithms such as exponential backoff.
https://github.com/patinthehat/backoffv2
algorithms backoff backoff-algorithms backoff-strategy composer-package exponential-backoff php
Last synced: 25 days ago
JSON representation
PHP library implementing various backoff alforithms such as exponential backoff.
- Host: GitHub
- URL: https://github.com/patinthehat/backoffv2
- Owner: patinthehat
- License: mit
- Created: 2017-02-15T09:29:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-02-16T14:39:20.000Z (over 7 years ago)
- Last Synced: 2024-04-25T21:22:49.593Z (6 months ago)
- Topics: algorithms, backoff, backoff-algorithms, backoff-strategy, composer-package, exponential-backoff, php
- Language: PHP
- Size: 9.77 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## BackoffV2 [](https://travis-ci.org/patinthehat/BackoffV2)
---
BackoffV2 is a PHP 5.5+ library implementing various backoff algorithms, such as [exponential backoff](http://en.wikipedia.org/wiki/Exponential_backoff).
This library only returns a backoff delay amount based on the selected algorithms; implementation of the actual delay mechanism (such as [sleep()](http://php.net/manual/en/function.sleep.php)) is left to the user.
---
#### Installation
Install BackoffV2 with [Composer](https://getcomposer.org/):
`composer require patinthehat/backoffv2`
---
#### Implementation
"Jitter" is implemented, if you choose to use it. Jitter is a small, variable amount of time that is added to the backoff amount.
---
Available Jitter algorithms (roughly based on [this post](https://www.awsarchitectureblog.com/2015/03/backoff.html)) include:
- NoJitter - No jitter
- FullJitter - Standard jitter amount
- EqualJitter - More consistent jitter amounts
- DecorrelatedJitter - Higher jitter amounts
---
Backoff algorithms include:
- ExponentialBackoff - exponentially increase the backoff amount
- ConstantBackoff - use the same backoff amount, regardless of the attempt count.
- LinearBackoff - linear increase of the backoff amount, i.e. 1, 2, 3, 4, ...
---
#### Usage
---
##### Using the Backoff class
BackoffV2 implements a main class, `Backoff`, that acts as a container and manager for the backoff and jitter algorithms you choose.
The constructor signature for `Backoff` is:
```php
public function __construct($maxBackoff, BackoffStrategyInterface $backoff, JitterStrategyInterface $jitter)
```
Usage is simple:
```php
include 'vendor/autoload.php';
use BackoffV2\Backoff;
use BackoffV2\Backoff\ExponentialBackoff;
use BackoffV2\Jitter\FullJitter;
$b = new Backoff(15, new ExponentialBackoff, new FullJitter);
echo 'backoff = '.$b->getBackoff() . PHP_EOL;
echo 'backoff = '.$b->getBackoff() . PHP_EOL;
echo 'backoff = '.$b->getBackoff() . PHP_EOL;
echo 'backoff = '.$b->getBackoff() . PHP_EOL;
echo 'backoff = '.$b->getBackoff() . ' (attempt ' . $b->getAttempt().')' . PHP_EOL;
$b->reset();
```
---
#### License
BackoffV2 is available under the [MIT License](LICENSE).