retrypolicy

Documentation

Index

• Constants
• Variables
• type Option
  • func WithBackoffCoefficient(backoffCoefficient float64) Option
  • func WithExpirationInterval(expirationInterval time.Duration) Option
  • func WithInitialInterval(initialInterval time.Duration) Option
  • func WithMaximumAttempts(maximumAttempts int) Option
  • func WithMaximumInterval(maximumInterval time.Duration) Option
• type Retry
  • func New(options ...Option) (Retry, error)

Constants

const Done time.Duration = -1

Done is returned when CalculateNextDelay has reached it delay retry limit

Variables

var (
	// DefaultRetry a default policy
	DefaultRetry, _ = New(
		WithInitialInterval(50*time.Millisecond),
		WithBackoffCoefficient(2.0),
		WithMaximumInterval(10*time.Second),
		WithExpirationInterval(time.Minute),
		WithMaximumAttempts(10),
	)

	// NoRetry policy to be used if no retries are required
	NoRetry, _ = New(
		WithInitialInterval(0),
		WithBackoffCoefficient(0),
		WithMaximumInterval(0),
		WithExpirationInterval(0),
		WithMaximumAttempts(0),
	)
)

Types

type Option

type Option func(policy *policy) error

Option func to build retry policy

func WithBackoffCoefficient

func WithBackoffCoefficient(backoffCoefficient float64) Option

WithBackoffCoefficient sets the coefficient used to calculate next interval

func WithExpirationInterval

func WithExpirationInterval(expirationInterval time.Duration) Option

WithExpirationInterval sets the maximum elapsed time an operation should be tried for

func WithInitialInterval

func WithInitialInterval(initialInterval time.Duration) Option

WithInitialInterval sets the initial interval

func WithMaximumAttempts

func WithMaximumAttempts(maximumAttempts int) Option

WithMaximumAttempts sets the maximum number of times an operation will be tried

func WithMaximumInterval

func WithMaximumInterval(maximumInterval time.Duration) Option

WithMaximumInterval sets the maximum time that can be calculated for next interval

type Retry

type Retry interface {
	// CalculateNextDelay implementations should return the next delay interval
	CalculateNextDelay() time.Duration
}

Retry api

func New

func New(options ...Option) (Retry, error)

New return a new instance of retry policy