attempt

Documentation

Index

• type Attempt
  • func (a *Attempt) HasNext() bool
  • func (a *Attempt) Next() bool
• type Strategy
  • func (s Strategy) Run(f func() error) error
  • func (s Strategy) Start() *Attempt

Types

type Attempt

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

func (*Attempt) HasNext

func (a *Attempt) HasNext() bool

HasNext returns whether another attempt will be made if the current one fails. If it returns true, the following call to Next is guaranteed to return true.

func (*Attempt) Next

func (a *Attempt) Next() bool

Next waits until it is time to perform the next attempt or returns false if it is time to stop trying.

type Strategy

type Strategy struct {
	Total time.Duration // total duration of attempt.
	Delay time.Duration // interval between each try in the burst.
	Min   int           // minimum number of retries; overrides Total
}

AttemptStrategy represents a strategy for waiting for an action to complete successfully.

func (Strategy) Run

func (s Strategy) Run(f func() error) error

func (Strategy) Start

func (s Strategy) Start() *Attempt

Start begins a new sequence of attempts for the given strategy.