backoff

Documentation

Index

• Variables
• type Backoff
  • func New(opts ...Option) (*Backoff, error)
  • func (b *Backoff) Reset()
  • func (b Backoff) Validate() error
  • func (b *Backoff) Wait(ctx context.Context) (Stat, error)
• type Option
  • func WithExponentialStrategy(opts ...strategies.ExponentialOption) Option
  • func WithMaxRetries(mr uint32) Option
  • func WithName(name string) Option
  • func WithStrategy(s strategies.Interface) Option
• type RetryLimitError
  • func (e RetryLimitError) Error() string
• type Stat
  • func (s Stat) String() string

Variables

var EmptyStat = Stat{}

Types

type Backoff

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

func New

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

func (*Backoff) Reset

func (b *Backoff) Reset()

func (Backoff) Validate

func (b Backoff) Validate() error

func (*Backoff) Wait

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

type Option

type Option = c.Option[Backoff]

func WithExponentialStrategy

func WithExponentialStrategy(opts ...strategies.ExponentialOption) Option

func WithMaxRetries

func WithMaxRetries(mr uint32) Option

func WithName

func WithName(name string) Option

func WithStrategy

func WithStrategy(s strategies.Interface) Option

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