re
/
backoff
forked from mirror/backoff
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Explicitly document the default values

This commit is contained in:
Kishan B 2022-03-30 11:32:44 +05:30 committed by GitHub
parent d80867952d
commit d634e7dfab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
backoff.go
View File

@ -16,12 +16,26 @@ import (
// be used concurrently. // be used concurrently.
type Backoff struct { type Backoff struct {
attempt uint64 attempt uint64
// Factor is the multiplying factor for each increment step
// Factor is the multiplying factor for each increment step.
//
// Defaults to 2.
Factor float64 Factor float64
// Jitter eases contention by randomizing backoff steps
// Jitter eases contention by randomizing backoff steps.
//
// Defaults to false.
Jitter bool Jitter bool
// Min and Max are the minimum and maximum values of the counter
Min, Max time.Duration // Minimum value of the counter.
//
// Defaults to 100 milliseconds.
Min
// Maximum value of the counter.
//
// Defaults to 10 seconds.
Max time.Duration
} }
// Duration returns the duration for the current attempt before incrementing // Duration returns the duration for the current attempt before incrementing