package backoff

Import Path
	google.golang.org/grpc/internal/backoff (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 3 packages

Involved Source Files

	  d backoff.go
		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.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Exponential (struct)
		Exponential implements exponential backoff algorithm as defined in
		https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.

		Fields (only one, which is exported)
			Config grpcbackoff.Config
				Config contains all options to configure the backoff algorithm.

		Methods (only one, which is exported)
			( Exponential) Backoff(retries int) time.Duration
				Backoff returns the amount of time to wait before the next retry given the
				number of retries.

		Implements (at least one exported)
			 Exponential : Strategy
		As Types Of (total 2, in which 1 is exported)
			  var DefaultExponential
			/* one unexported ... *//* one unexported: */
			  var google.golang.org/grpc/health.backoffStrategy

	 type Strategy (interface)
		Strategy defines the methodology for backing off after a grpc connection
		failure.

		Methods (only one, which is exported)
			( Strategy) Backoff(retries int) time.Duration
				Backoff returns the amount of time to wait before the next retry given
				the number of consecutive failures.

		Implemented By (at least one exported)
			 Exponential
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.withBackoff(bs Strategy) grpc.DialOption


Package-Level Functions (only one, which is exported)

	 func RunF(ctx context.Context, f func() error, backoff func(int) time.Duration)
		RunF provides a convenient way to run a function f repeatedly until the
		context expires or f returns a non-nil error that is not ErrResetBackoff.
		When f returns ErrResetBackoff, RunF continues to run f, but resets its
		backoff state before doing so. backoff accepts an integer representing the
		number of retries, and returns the amount of time to backoff.


Package-Level Variables (total 2, both are exported)

	  var DefaultExponential Exponential
		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.

	  var ErrResetBackoff error
		ErrResetBackoff is the error to be returned by the function executed by RunF,
		to instruct the latter to reset its backoff state.

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)