backoff

README

backoff

backoff provides a simple backoff and jitter implementation for retrying operations

As described in:

• https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/

Bounded retries:

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/brunotm/backoff"
)

func main() {
	count := 0
	err := backoff.Retry(
		context.Background(), 100, 1*time.Second, 60*time.Second,
		func() error {
			count++
			fmt.Println("Count: ", count)
			if count == 5 {
				return nil
			}
			return fmt.Errorf("op error")
		})
	fmt.Println(err)
}

Unbounded retries:

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/brunotm/backoff"
)

func main() {
	count := 0
	// Until only returns an error when the context is done.
	err := backoff.Until(
		context.Background(), 1*time.Second, 60*time.Second,
		func() error {
			count++
			fmt.Println("Count: ", count)
			if count == 5 {
				return nil
			}
			return fmt.Errorf("op error")
		})
	fmt.Println(err)
}

Written by Bruno Moura brunotm@gmail.com

Documentation

Index

• Variables
• func Retry(ctx context.Context, attempts int, base, max time.Duration, f func() error) (err error)
• func Until(ctx context.Context, base, max time.Duration, f func() error) (err error)

Variables

var (
	// ErrContextDone returned when context is canceled
	ErrContextDone = errors.New("context done")
)

Functions

func Retry

func Retry(ctx context.Context, attempts int, base, max time.Duration, f func() error) (err error)

Retry the given function n times jittering between max and min time.Duration

func Until

func Until(ctx context.Context, base, max time.Duration, f func() error) (err error)

Until is like retry but retries until success