retry

README

retry

重试机制：支持最大次数、固定延迟、退避、抖动。

安装

import "github.com/Ccmuyu/gopkg/retry"

快速开始

err := retry.Retry(func() error {
    return doSomething()
}, retry.WithMaxAttempts(5),
   retry.WithDelay(100*time.Millisecond),
   retry.WithBackoff(),
   retry.WithJitter())

需要取消或截止时间时使用 RetryCtx。已取消的 context 不会执行回调。 maxAttempts <= 0 会归一化为 1，确保操作至少执行一次。

err := retry.RetryCtx(ctx, func() error {
    return doSomething()
}, retry.WithMaxAttempts(5))

API 参考

func Retry(fn func() error, opts ...Option) error
func RetryCtx(ctx context.Context, fn func() error, opts ...Option) error
func WithMaxAttempts(n int) Option
func WithDelay(d time.Duration) Option
func WithBackoff() Option
func WithJitter() Option

Documentation

Index

• func Retry(fn func() error, opts ...Option) error
• func RetryCtx(ctx context.Context, fn func() error, opts ...Option) error
• type Option
  • func WithBackoff() Option
  • func WithDelay(d time.Duration) Option
  • func WithJitter() Option
  • func WithMaxAttempts(n int) Option

Functions

func Retry

func Retry(fn func() error, opts ...Option) error

func RetryCtx

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

Types

type Option

type Option func(*options)

func WithBackoff

func WithBackoff() Option

func WithDelay

func WithDelay(d time.Duration) Option

func WithJitter

func WithJitter() Option

func WithMaxAttempts

func WithMaxAttempts(n int) Option