cockroach: github.com/abhinavdahiya/cockroach/util/retry Index | Files

package retry

import "github.com/abhinavdahiya/cockroach/util/retry"

Index

Package Files

retry.go

type Options Uses

type Options struct {
    InitialBackoff      time.Duration   // Default retry backoff interval
    MaxBackoff          time.Duration   // Maximum retry backoff interval
    Multiplier          float64         // Default backoff constant
    MaxRetries          int             // Maximum number of attempts (0 for infinite)
    RandomizationFactor float64         // Randomize the backoff interval by constant
    Closer              <-chan struct{} // Optionally end retry loop channel close.
}

Options provides reusable configuration of Retry objects.

type Retry Uses

type Retry struct {
    // contains filtered or unexported fields
}

Retry implements the public methods necessary to control an exponential- backoff retry loop.

func Start Uses

func Start(opts Options) Retry

Start returns a new Retry initialized to some default values. The Retry can then be used in an exponential-backoff retry loop.

func (*Retry) CurrentAttempt Uses

func (r *Retry) CurrentAttempt() int

CurrentAttempt it is zero initially and increases with each call to Next() which does not immediately follow a Reset().

func (*Retry) Next Uses

func (r *Retry) Next() bool

Next returns whether the retry loop should continue, and blocks for the appropriate length of time before yielding back to the caller. If a stopper is present, Next will eagerly return false when the stopper is stopped.

func (*Retry) Reset Uses

func (r *Retry) Reset()

Reset resets the Retry to its initial state, meaning that the next call to Next will return true immediately and subsequent calls will behave as if they had followed the very first attempt (i.e. their backoffs will be short).

Package retry imports 3 packages (graph). Updated 2017-03-13. Refresh now. Tools for package owners. This is a dead-end fork (no commits since the fork).