retry

Documentation

Index

• Variables
• func Do(ctx context.Context, fn RetriesFunc, opts ...Option) error
• type BackoffStrategy
• type Config
• type Constant
  • func NewConstant(d time.Duration) *Constant
  • func (c *Constant) Sleep(_ int) time.Duration
• type Fibonacci
  • func NewFibonacci(d time.Duration) *Fibonacci
  • func (f *Fibonacci) Sleep(times int) time.Duration
• type HookFunc
• type Linear
  • func NewLinear(d time.Duration) *Linear
  • func (l *Linear) Sleep(times int) time.Duration
• type Option
  • func WithAfterHook(hook HookFunc) Option
  • func WithBackOffStrategy(s BackoffStrategy, duration time.Duration) Option
  • func WithBeforeHook(hook HookFunc) Option
  • func WithCustomStrategy(s Strategy) Option
  • func WithMaxRetryTimes(times int) Option
  • func WithRecoverPanic() Option
  • func WithRetryChecker(checker RetriesChecker) Option
  • func WithTimeout(timeout time.Duration) Option
• type RetriesChecker
• type RetriesFunc
• type Strategy

Variables

var (
	ErrorAbort                 = errors.New("stop retry")
	ErrorTimeout               = errors.New("retry timeout")
	ErrorContextDeadlineExceed = errors.New("context deadline exceeded")
	ErrorEmptyRetryFunc        = errors.New("empty retry function")
	ErrorTimeFormat            = errors.New("time out err")
)

var (
	DefaultMaxRetryTimes = 3
	DefaultTimeout       = time.Minute
	DefaultInterval      = time.Second * 2
	DefaultRetryChecker  = func(err error) bool {
		return !errors.Is(err, ErrorAbort)
	}
)

Functions

func Do

func Do(ctx context.Context, fn RetriesFunc, opts ...Option) error

Types

type BackoffStrategy

type BackoffStrategy int

const (
	StrategyConstant BackoffStrategy = iota
	StrategyLinear
	StrategyFibonacci
)

type Config

type Config struct {
	MaxRetryTimes int
	Timeout       time.Duration
	RetryChecker  RetriesChecker
	Strategy      Strategy
	RecoverPanic  bool
	BeforeTry     HookFunc
	AfterTry      HookFunc
}

type Constant

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

func NewConstant

func NewConstant(d time.Duration) *Constant

func (*Constant) Sleep

func (c *Constant) Sleep(_ int) time.Duration

type Fibonacci

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

func NewFibonacci

func NewFibonacci(d time.Duration) *Fibonacci

func (*Fibonacci) Sleep

func (f *Fibonacci) Sleep(times int) time.Duration

type HookFunc

type HookFunc func()

type Linear

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

func NewLinear

func NewLinear(d time.Duration) *Linear

func (*Linear) Sleep

func (l *Linear) Sleep(times int) time.Duration

type Option

type Option func(c *Config)

func WithAfterHook

func WithAfterHook(hook HookFunc) Option

func WithBackOffStrategy

func WithBackOffStrategy(s BackoffStrategy, duration time.Duration) Option

func WithBeforeHook

func WithBeforeHook(hook HookFunc) Option

func WithCustomStrategy

func WithCustomStrategy(s Strategy) Option

func WithMaxRetryTimes

func WithMaxRetryTimes(times int) Option

func WithRecoverPanic

func WithRecoverPanic() Option

func WithRetryChecker

func WithRetryChecker(checker RetriesChecker) Option

func WithTimeout

func WithTimeout(timeout time.Duration) Option

type RetriesChecker

type RetriesChecker func(err error) (needRetry bool)

type RetriesFunc

type RetriesFunc func() error

type Strategy

type Strategy interface {
	Sleep(times int) time.Duration
}