mirror of https://github.com/jpillora/backoff.git
63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
|
# Backoff
|
||
|
|
|
||
|
|
A simple backoff algorithm in Go (Golang)
|
||
|
|
|
||
|
|
# Usage
|
||
|
|
|
||
|
|
Starts at `Min`, multiplied by `Factor` every call to
|
||
|
|
`Duration()` where it is capped at `Max`. Commonly used
|
||
|
|
in conjunction with `time.Sleep(duration)`.
|
||
|
|
|
||
|
|
``` go
|
||
|
|
|
||
|
|
b := &backoff.Backoff{
|
||
|
|
//These are the defaults
|
||
|
|
Min: 100 * time.Millisecond,
|
||
|
|
Max: 10 * time.Second,
|
||
|
|
Factor: 2,
|
||
|
|
}
|
||
|
|
|
||
|
|
fmt.Printf("%s\n", b.Duration())
|
||
|
|
fmt.Printf("%s\n", b.Duration())
|
||
|
|
fmt.Printf("%s\n", b.Duration())
|
||
|
|
|
||
|
|
fmt.Printf("Reset!\n")
|
||
|
|
b.Reset()
|
||
|
|
|
||
|
|
fmt.Printf("%s\n", b.Duration())
|
||
|
|
```
|
||
|
|
|
||
|
|
```
|
||
|
|
100ms
|
||
|
|
200ms
|
||
|
|
400ms
|
||
|
|
Reset!
|
||
|
|
100ms
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Credits
|
||
|
|
|
||
|
|
Ported from some JavaScript written by [@tj](https://github.com/tj)
|
||
|
|
|
||
|
|
#### MIT License
|
||
|
|
|
||
|
|
Copyright © 2015 Jaime Pillora <dev@jpillora.com>
|
||
|
|
|
||
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
||
|
|
a copy of this software and associated documentation files (the
|
||
|
|
'Software'), to deal in the Software without restriction, including
|
||
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
||
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||
|
|
permit persons to whom the Software is furnished to do so, subject to
|
||
|
|
the following conditions:
|
||
|
|
|
||
|
|
The above copyright notice and this permission notice shall be
|
||
|
|
included in all copies or substantial portions of the Software.
|
||
|
|
|
||
|
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||
|
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||
|
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|