File: backoff.go

package info (click to toggle)
golang-google-api 0.0~git20161128.3cc2e59-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch, stretch-backports
  • size: 64,468 kB
  • ctags: 71,262
  • sloc: makefile: 16
file content (46 lines) | stat: -rw-r--r-- 1,186 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// Copyright 2016 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package gensupport

import (
	"math/rand"
	"time"
)

type BackoffStrategy interface {
	// Pause returns the duration of the next pause and true if the operation should be
	// retried, or false if no further retries should be attempted.
	Pause() (time.Duration, bool)

	// Reset restores the strategy to its initial state.
	Reset()
}

// ExponentialBackoff performs exponential backoff as per https://en.wikipedia.org/wiki/Exponential_backoff.
// The initial pause time is given by Base.
// Once the total pause time exceeds Max, Pause will indicate no further retries.
type ExponentialBackoff struct {
	Base  time.Duration
	Max   time.Duration
	total time.Duration
	n     uint
}

func (eb *ExponentialBackoff) Pause() (time.Duration, bool) {
	if eb.total > eb.Max {
		return 0, false
	}

	// The next pause is selected from randomly from [0, 2^n * Base).
	d := time.Duration(rand.Int63n((1 << eb.n) * int64(eb.Base)))
	eb.total += d
	eb.n++
	return d, true
}

func (eb *ExponentialBackoff) Reset() {
	eb.n = 0
	eb.total = 0
}