backoff

Documentation

Index

• Variables
• type Backoff
  • func New(opts ...BackoffOption) (*Backoff, error)
  • func (b *Backoff) Reset()
  • func (b *Backoff) Wait(ctx context.Context) (Stat, error)
• type BackoffOption
  • func WithMaxRetries(mr uint32) BackoffOption
  • func WithName(name string) BackoffOption
  • func WithStrategy(s Strategy) BackoffOption
• type ExponentialOption
  • func WithJitter(j float64) ExponentialOption
  • func WithMaxDelay(d time.Duration) ExponentialOption
  • func WithMinDelay(d time.Duration) ExponentialOption
  • func WithMultiplier(m float64) ExponentialOption
• type RetryLimitError
  • func (e RetryLimitError) Error() string
• type Stat
  • func (s Stat) String() string
• type Strategy
  • func NewExponentialStrategy(opts ...ExponentialOption) (Strategy, error)

Variables

var EmptyStat = Stat{}

Types

type Backoff

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

func New

func New(opts ...BackoffOption) (*Backoff, error)

func (*Backoff) Reset

func (b *Backoff) Reset()

func (*Backoff) Wait

func (b *Backoff) Wait(ctx context.Context) (Stat, error)

type BackoffOption

type BackoffOption = c.Option[Backoff]

func WithMaxRetries

func WithMaxRetries(mr uint32) BackoffOption

func WithName

func WithName(name string) BackoffOption

func WithStrategy

func WithStrategy(s Strategy) BackoffOption

type ExponentialOption

type ExponentialOption = c.Option[exponential]

func WithJitter

func WithJitter(j float64) ExponentialOption

func WithMaxDelay

func WithMaxDelay(d time.Duration) ExponentialOption

func WithMinDelay

func WithMinDelay(d time.Duration) ExponentialOption

func WithMultiplier

func WithMultiplier(m float64) ExponentialOption

type RetryLimitError

type RetryLimitError struct {
	BackoffName string
	MaxRetries  uint32
}

func (RetryLimitError) Error

func (e RetryLimitError) Error() string

type Stat

type Stat struct {
	Duration   time.Duration
	RetryIndex uint32
	MaxRetries uint32
}

func (Stat) String

func (s Stat) String() string

type Strategy

type Strategy interface {
	Duration(retries uint32) time.Duration
}

func NewExponentialStrategy

func NewExponentialStrategy(opts ...ExponentialOption) (Strategy, error)