try

README

try

a function to repeat another one until it succeeds

Documentation

Index

• Constants
• Variables
• func Forever(try TryFunc) error
• func Try(max int, try TryFunc) error
• func TryContext(ctx context.Context, max int, try TryFunc) error
• type JitterFunc
• type Option
  • func WithBackoff(d time.Duration) Option
  • func WithJitter(fn JitterFunc) Option
  • func WithWait(d time.Duration) Option
• type Retry
  • func New(limit int, options ...Option) (*Retry, error)
  • func (r *Retry) Try(try TryFunc) error
  • func (r *Retry) TryContext(ctx context.Context, try TryFunc) error
• type TryFunc

Constants

const (
	DefaultDelay   = time.Second
	DefaultBackoff = DefaultDelay * 64
)

Variables

var (
	ErrAttempt  = errors.New("try: max attempt reached")
	ErrAbort    = errors.New("try: abort")
	ErrNoErr    = errors.New("try: no error")
	ErrDuration = errors.New("try: invalid duration")
)

Functions

func Forever

func Forever(try TryFunc) error

func Try

func Try(max int, try TryFunc) error

func TryContext

func TryContext(ctx context.Context, max int, try TryFunc) error

Types

type JitterFunc

type JitterFunc func() time.Duration

type Option

type Option func(r *Retry) error

func WithBackoff

func WithBackoff(d time.Duration) Option

func WithJitter

func WithJitter(fn JitterFunc) Option

func WithWait

func WithWait(d time.Duration) Option

type Retry

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

func New

func New(limit int, options ...Option) (*Retry, error)

func (*Retry) Try

func (r *Retry) Try(try TryFunc) error

func (*Retry) TryContext

func (r *Retry) TryContext(ctx context.Context, try TryFunc) error

type TryFunc

type TryFunc func(int) error