retry

Documentation

Overview

Package retry provides simple retry wrappers for functions that return an error

Index

• Variables
• func Context(ctx context.Context, f func(ctx context.Context) error) error
• func Timeout(ctx context.Context, timeout time.Duration, f func(ctx context.Context) error) error
• func Times(ctx context.Context, times int, f func(context.Context) error) error

Variables

var (
	// DefaultTimeout is a default timeout for retry operations
	DefaultTimeout = 2 * time.Minute
	// Interval is the time to wait between retry attempts
	Interval = 5 * time.Second
	// ErrAbort should be returned when an error occurs on which retrying should be aborted
	ErrAbort = errors.New("retrying aborted")
)

Functions

func Context

func Context(ctx context.Context, f func(ctx context.Context) error) error

Context is a retry wrapper that will retry the given function until it succeeds or the context is cancelled

func Timeout

func Timeout(ctx context.Context, timeout time.Duration, f func(ctx context.Context) error) error

Timeout is a retry wrapper that will retry the given function until it succeeds, the context is cancelled, or the timeout is reached

func Times

func Times(ctx context.Context, times int, f func(context.Context) error) error

Times is a retry wrapper that will retry the given function until it succeeds or the given number of attempts have been made