retry

README

retry

An exponentially backing off retry package for Go.

go get github.com/coder/retry

Features

• A for loop experience instead of closures
• Only 3 exported methods
• No external dependencies

Examples

Wait for connectivity to google.com, checking at most once every second.

func pingGoogle(ctx context.Context) error {
	var err error
	
	for r := retry.New(time.Second, time.Second*10); r.Wait(ctx); {
		_, err = http.Get("https://google.com")
		if err != nil {
			continue
		}
		break
	}
	return err
}

Wait for connectivity to google.com, checking at most 10 times.

func pingGoogle(ctx context.Context) error {
	var err error
	
	for r := retry.New(time.Second, time.Second*10); n := 0; r.Wait(ctx) && n < 10; n++ {
		_, err = http.Get("https://google.com")
		if err != nil {
			continue
		}
		break
	}
	return err
}

Documentation

Overview

Package retry runs a fallible block of code until it succeeds.

Index

• type Retrier
  • func New(floor, ceil time.Duration) *Retrier
  • func (r *Retrier) Reset()
  • func (r *Retrier) Wait(ctx context.Context) bool

Types

type Retrier

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

Retrier implements an exponentially backing off retry instance. Use New instead of creating this object directly.

func New

func New(floor, ceil time.Duration) *Retrier

New creates a retrier that exponentially backs off from floor to ceil pauses.

func (*Retrier) Reset

func (r *Retrier) Reset()

Reset resets the retrier to its initial state.

func (*Retrier) Wait

func (r *Retrier) Wait(ctx context.Context) bool