backoff

Documentation

Index

• Variables
• type Backoff
• type Config
• type ConstantBackoff
  • func NewConstantBackoff(ctx context.Context, cfg *ConstantConfig) *ConstantBackoff
  • func (cbo *ConstantBackoff) Retry(op Operation) error
  • func (cbo *ConstantBackoff) RetryNotify(op Operation, notify Notify) error
• type ConstantConfig
• type ExponentialBackoff
  • func NewExponentialBackoff(ctx context.Context, cfg *ExponentialConfig) *ExponentialBackoff
  • func (ebo *ExponentialBackoff) Retry(op Operation) error
  • func (ebo *ExponentialBackoff) RetryNotify(op Operation, notify Notify) error
• type ExponentialConfig
• type Notify
• type Operation
• type Provider
  • func NewProvider(cfg *Config) Provider
• type StopBackoff
  • func NewStopBackoff() *StopBackoff
  • func (sbo *StopBackoff) Retry(op Operation) error
  • func (sbo *StopBackoff) RetryNotify(op Operation, notify Notify) error

Variables

var ErrPermanent = errors.New("permanent error, do not retry")

Types

type Backoff

type Backoff interface {
	RetryNotify(Operation, Notify) error
	Retry(Operation) error
}

type Config

type Config struct {
	Exponential *ExponentialConfig
	Constant    *ConstantConfig
}

type ConstantBackoff

type ConstantBackoff struct {
	backoff.BackOff
}

func NewConstantBackoff

func NewConstantBackoff(ctx context.Context, cfg *ConstantConfig) *ConstantBackoff

func (*ConstantBackoff) Retry

func (cbo *ConstantBackoff) Retry(op Operation) error

func (*ConstantBackoff) RetryNotify

func (cbo *ConstantBackoff) RetryNotify(op Operation, notify Notify) error

type ConstantConfig

type ConstantConfig struct {
	Interval   time.Duration
	MaxRetries uint
}

type ExponentialBackoff

type ExponentialBackoff struct {
	backoff.BackOff
}

ExponentialBackoff is a wrapper around the cenkalti exponential backoff

func NewExponentialBackoff

func NewExponentialBackoff(ctx context.Context, cfg *ExponentialConfig) *ExponentialBackoff

func (*ExponentialBackoff) Retry

func (ebo *ExponentialBackoff) Retry(op Operation) error

func (*ExponentialBackoff) RetryNotify

func (ebo *ExponentialBackoff) RetryNotify(op Operation, notify Notify) error

type ExponentialConfig

type ExponentialConfig struct {
	InitialInterval time.Duration
	MaxInterval     time.Duration
	MaxRetries      uint
}

type Notify

type Notify func(error, time.Duration)

type Operation

type Operation func() error

type Provider

type Provider func(ctx context.Context) Backoff

func NewProvider

func NewProvider(cfg *Config) Provider

NewProvider returns a backoff provider based on the config on input. If no valid input is provided, a no retry backoff provider is returned instead.

type StopBackoff

type StopBackoff struct {
	backoff.BackOff
}

func NewStopBackoff

func NewStopBackoff() *StopBackoff

func (*StopBackoff) Retry

func (sbo *StopBackoff) Retry(op Operation) error

func (*StopBackoff) RetryNotify

func (sbo *StopBackoff) RetryNotify(op Operation, notify Notify) error