backoff

Documentation

Overview

Package backoff implement the backoff strategy for gRPC.

This is kept in internal until the gRPC project decides whether or not to allow alternative backoff strategies.

Index

• Variables
• type Exponential
  • func (bc Exponential) Backoff(retries int) time.Duration
• type Strategy

Variables

var DefaultExponential = Exponential{Config: grpcbackoff.DefaultConfig}

DefaultExponential is an exponential backoff implementation using the default values for all the configurable knobs defined in https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.

Types

type Exponential

type Exponential struct {
	// Config contains all options to configure the backoff algorithm.
	Config grpcbackoff.Config
}

Exponential implements exponential backoff algorithm as defined in https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.

func (Exponential) Backoff

func (bc Exponential) Backoff(retries int) time.Duration

Backoff returns the amount of time to wait before the next retry given the number of retries.

type Strategy

type Strategy interface {
	// Backoff returns the amount of time to wait before the next retry given
	// the number of consecutive failures.
	Backoff(retries int) time.Duration
}

Strategy defines the methodology for backing off after a grpc connection failure.