| 1 |
# Exponential Backoff [![GoDoc][godoc image]][godoc] [![Build Status][travis image]][travis] [![Coverage Status][coveralls image]][coveralls] |
| 2 |
|
| 3 |
This is a Go port of the exponential backoff algorithm from [Google's HTTP Client Library for Java][google-http-java-client]. |
| 4 |
|
| 5 |
[Exponential backoff][exponential backoff wiki] |
| 6 |
is an algorithm that uses feedback to multiplicatively decrease the rate of some process, |
| 7 |
in order to gradually find an acceptable rate. |
| 8 |
The retries exponentially increase and stop increasing when a certain threshold is met. |
| 9 |
|
| 10 |
## Usage |
| 11 |
|
| 12 |
See https://godoc.org/github.com/cenkalti/backoff#pkg-examples |
| 13 |
|
| 14 |
## Contributing |
| 15 |
|
| 16 |
* I would like to keep this library as small as possible. |
| 17 |
* Please don't send a PR without opening an issue and discussing it first. |
| 18 |
* If proposed change is not a common use case, I will probably not accept it. |
| 19 |
|
| 20 |
[godoc]: https://godoc.org/github.com/cenkalti/backoff |
| 21 |
[godoc image]: https://godoc.org/github.com/cenkalti/backoff?status.png |
| 22 |
[travis]: https://travis-ci.org/cenkalti/backoff |
| 23 |
[travis image]: https://travis-ci.org/cenkalti/backoff.png?branch=master |
| 24 |
[coveralls]: https://coveralls.io/github/cenkalti/backoff?branch=master |
| 25 |
[coveralls image]: https://coveralls.io/repos/github/cenkalti/backoff/badge.svg?branch=master |
| 26 |
|
| 27 |
[google-http-java-client]: https://github.com/google/google-http-java-client/blob/da1aa993e90285ec18579f1553339b00e19b3ab5/google-http-client/src/main/java/com/google/api/client/util/ExponentialBackOff.java |
| 28 |
[exponential backoff wiki]: http://en.wikipedia.org/wiki/Exponential_backoff |
| 29 |
|
| 30 |
[advanced example]: https://godoc.org/github.com/cenkalti/backoff#example_ |