retry

Documentation

Index

• Constants
• func InitConfig(conf config.Section)
• type Retry
  • func NewFromConfig(conf config.Section) *Retry
  • func (r *Retry) Do(ctx context.Context, logDescription string, ...) error
  • func (r *Retry) DoCustomLog(ctx context.Context, f func(attempt int) (retry bool, err error)) error

Constants

const (
	ConfigInitialDelay = "initialDelay"
	ConfigMaximumDelay = "maxDelay"
	ConfigFactor       = "factor"
)

Functions

func InitConfig

func InitConfig(conf config.Section)

Types

type Retry

type Retry struct {
	InitialDelay time.Duration   `ffstruct:"RetryConfig" json:"initialDelay,omitempty"`
	MaximumDelay time.Duration   `ffstruct:"RetryConfig" json:"maximumDelay,omitempty"`
	Factor       float64         `ffstruct:"RetryConfig" json:"factor,omitempty"`
	ErrCallback  func(err error) `json:"-"`
}

Retry is a concurrency safe retry structure that configures a simple backoff retry mechanism. Can be loaded directly from JSON/YAML config

func NewFromConfig

func NewFromConfig(conf config.Section) *Retry

func (*Retry) Do

func (r *Retry) Do(ctx context.Context, logDescription string, f func(attempt int) (retry bool, err error)) error

Do invokes the function until the function returns false, or the retry pops. This simple interface doesn't pass through errors or return values, on the basis you'll be using a closure for that.

func (*Retry) DoCustomLog

func (r *Retry) DoCustomLog(ctx context.Context, f func(attempt int) (retry bool, err error)) error

DoCustomLog disables the automatic attempt logging, so the caller should do logging for each attempt