retry

type AttemptResult ¶

type AttemptResult int

const (
	// Continue means there was no error and polling can continue normally.
	Continue AttemptResult = iota
	// ContinueImmediately means there was no error and polling can continue normally.
	ContinueImmediately
	// Backoff means there was a retriable error, so the caller should try later.
	Backoff
	// Done means the polling should stop. There may or may not have been an error.
	Done
)

type BackoffConfig ¶

type BackoffConfig interface {
	Next(clock clock.Clock) time.Duration
	Clone() BackoffConfig
}

func NewExponentialBackoff(initBackoff, maxBackoff, resetDuration time.Duration, backoffFactor, jitter float64) BackoffConfig

type PokeChannel ¶

type PokeChannel chan struct{}

func NewPokeChannel() PokeChannel

func (c PokeChannel) Poke()

type PollConfig ¶

type PollConfig struct {
	Interval time.Duration
	Backoff  BackoffConfig
}

type PollOption ¶

type PollOption func(*pollOptions)

func WithClock(c clock.Clock) PollOption

func WithPokeChannel(c PokeChannel) PollOption

type PollWithBackoffCtxFunc ¶

type PollWithBackoffCtxFunc func(ctx context.Context) (error, AttemptResult)

PollWithBackoffCtxFunc is a function that is called to perform polling. Signature is unusual because AttemptResult must be checked, not the error.

type PollWithBackoffFunc ¶

type PollWithBackoffFunc func() (error, AttemptResult)

PollWithBackoffFunc is a function that is called to perform polling. Signature is unusual because AttemptResult must be checked, not the error.