retry

Documentation

Overview

Package retry allows multiple goroutines to function until it succeeds.

Index

• type Retry
  • func (r *Retry) Do(f func() error) error

Types

type Retry

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

Retry is an object that will perform an action until it succeeds.

func (*Retry) Do

func (r *Retry) Do(f func() error) error

Do calls f once and returns the result of f until f returns nil. Once f return nil, calling Do on this instance no longer calls f even if f changes but simply returns nil. Calling Do on this instance with multiple goroutines gates calls to f so that only only one goroutine at a time calls f while the others block.