backoff

README

Exponential Backoff

Documentation

Index

• func Retry(strategy Strategy, fn Func) error
• func RetryWithContext(ctx context.Context, strategy Strategy, fn Func) error
• type Func
• type Strategy

Functions

func Retry

func Retry(strategy Strategy, fn Func) error

Retry keeps trying the fn until it returns false or no error. It will pause between retries according to backoff strategy.

func RetryWithContext

func RetryWithContext(ctx context.Context, strategy Strategy, fn Func) error

RetryWithContext keeps trying the fn until it returns false or no error. It will pause between retries according to backoff strategy. If context is canceled during a pause context error is returned without re-calling provided fn.

Types

type Func

type Func func(attempt uint, reset func()) (retry bool, err error)

Func represents functions that can be retried, reset param shouldn't be called in new goroutine.

type Strategy

type Strategy interface {
	// Pause returns duration of the next pause, according to the attempt number.
	Pause(attempt uint) time.Duration
}

Strategy is a backoff methodology for retrying an operation.