throttling

Documentation

Index

• type Strategy
  • func NewDefaultStrategy(minDelay, maxDelay time.Duration, clock clock.Clock) (Strategy, error)
  • func NewDynamicStrategy(minDelay time.Duration, maxDelay time.Duration, ...) (Strategy, error)
  • func NewTwoWayStrategy(minDelay time.Duration, maxDelay time.Duration, ...) (Strategy, error)

Types

type Strategy

type Strategy interface {
	// Delay returns the delay for next request.
	Delay() time.Duration
	// Observe recalculates the next delay based on the feedback.
	Observe(err error)
}

Strategy handles delays based on feedbacks provided

func NewDefaultStrategy

func NewDefaultStrategy(minDelay, maxDelay time.Duration, clock clock.Clock) (Strategy, error)

func NewDynamicStrategy

func NewDynamicStrategy(
	minDelay time.Duration,
	maxDelay time.Duration,
	errorsBeforeIncreasingDelay int,
	successesBeforeDecreasingDelay int,
	successesBeforeResettingDelay int,
	noRequestsTimeoutBeforeDecreasingDelay time.Duration,
	noRequestsTimeoutBeforeResettingDelay time.Duration,
	clock clock.Clock) (Strategy, error)

func NewTwoWayStrategy

func NewTwoWayStrategy(
	minDelay time.Duration,
	maxDelay time.Duration,
	noRequestsTimeoutBeforeDecreasingDelay time.Duration,
	noRequestsTimeoutBeforeResettingDelay time.Duration,
	clock clock.Clock) (Strategy, error)