backoff

README

backoff

Backoff algorithms in Go for retrying operations

Documentation

Index

• func DefaultSuccess(err error) bool
• type Backoff
  • func ExponentialBackoff(min time.Duration, max time.Duration, factor float64) Backoff
  • func ExponentialBackoffWithSuccess(min time.Duration, max time.Duration, factor float64, success Success) Backoff
  • func LinearBackoff(attempts int, duration time.Duration) Backoff
  • func LinearBackoffWithSuccess(attempts int, duration time.Duration, success Success) Backoff
• type OnErr
• type Operation
• type Success

Functions

func DefaultSuccess

func DefaultSuccess(err error) bool

The default success condition

Types

type Backoff

type Backoff func(ctx context.Context, operation Operation, onErr OnErr) error

The backoff function

func ExponentialBackoff

func ExponentialBackoff(min time.Duration, max time.Duration, factor float64) Backoff

Performs an operation with an exponential backoff

func ExponentialBackoffWithSuccess

func ExponentialBackoffWithSuccess(min time.Duration, max time.Duration, factor float64, success Success) Backoff

Performs an operation with an exponential backoff using a custom success condition

func LinearBackoff

func LinearBackoff(attempts int, duration time.Duration) Backoff

Performs an operation with a linear backoff

func LinearBackoffWithSuccess

func LinearBackoffWithSuccess(attempts int, duration time.Duration, success Success) Backoff

Performs an operation with a linear backoff using a custom success condition

type OnErr

type OnErr func(err error)

Callback when we have an error

type Operation

type Operation func() error

The operation to perform in the backoff

type Success

type Success func(err error) bool

Returns true if the operation succeeded