expbackoff

Documentation

Overview

Package expbackoff provides an implementation of exponential backoff, useful for preventing client retries from overloading a recovering server.

Index

• type ExpBackoff
  • func Build(rng *rand.Rand, cfg backoff.Config) ExpBackoff
  • func BuildDefault() ExpBackoff
  • func (impl ExpBackoff) Backoff(retries int) time.Duration

Types

type ExpBackoff

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

ExpBackoff implements an exponential backoff algorithm with random jitter. The algorithm is identical to the one used in the guts of gRPC.

func Build

func Build(rng *rand.Rand, cfg backoff.Config) ExpBackoff

Build returns an ExpBackoff that uses a custom backoff configuration.

func BuildDefault

func BuildDefault() ExpBackoff

BuildDefault returns an ExpBackoff that uses the gRPC default backoff configuration.

func (ExpBackoff) Backoff

func (impl ExpBackoff) Backoff(retries int) time.Duration

Backoff returns the amount of time to wait until the next retry, given the existing retry count.