34 lines
1.7 KiB
Markdown
34 lines
1.7 KiB
Markdown
# Exponential Backoff [![GoDoc][godoc image]][godoc] [![Build Status][travis image]][travis] [![Coverage Status][coveralls image]][coveralls]
|
|
|
|
This is a Go port of the exponential backoff algorithm from [Google's HTTP Client Library for Java][google-http-java-client].
|
|
|
|
[Exponential backoff][exponential backoff wiki]
|
|
is an algorithm that uses feedback to multiplicatively decrease the rate of some process,
|
|
in order to gradually find an acceptable rate.
|
|
The retries exponentially increase and stop increasing when a certain threshold is met.
|
|
|
|
## Usage
|
|
|
|
Import path is `github.com/cenkalti/backoff/v3`. Please note the version part at the end.
|
|
|
|
godoc.org does not support modules yet,
|
|
so you can use https://godoc.org/gopkg.in/cenkalti/backoff.v3 to view the documentation.
|
|
|
|
## Contributing
|
|
|
|
* I would like to keep this library as small as possible.
|
|
* Please don't send a PR without opening an issue and discussing it first.
|
|
* If proposed change is not a common use case, I will probably not accept it.
|
|
|
|
[godoc]: https://godoc.org/github.com/cenkalti/backoff
|
|
[godoc image]: https://godoc.org/github.com/cenkalti/backoff?status.png
|
|
[travis]: https://travis-ci.org/cenkalti/backoff
|
|
[travis image]: https://travis-ci.org/cenkalti/backoff.png?branch=master
|
|
[coveralls]: https://coveralls.io/github/cenkalti/backoff?branch=master
|
|
[coveralls image]: https://coveralls.io/repos/github/cenkalti/backoff/badge.svg?branch=master
|
|
|
|
[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
|
|
[exponential backoff wiki]: http://en.wikipedia.org/wiki/Exponential_backoff
|
|
|
|
[advanced example]: https://godoc.org/github.com/cenkalti/backoff#example_
|