31911ed09e
* Implement missing pieces for connection backoff. Spec can be found here: https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md Summary of changes: * Added a new type (marked experimental), ConnectParams, which contains the knobs defined in the spec (except for minConnectTimeout). * Added a new API (marked experimental), WithConnectParams() to return a DialOption to dial with the provided parameters. * Added new fields to the implementation of the exponential backoff in internal/backoff which mirror the ones in ConnectParams. * Marked existing APIs WithBackoffMaxDelay() and WithBackoffConfig() as deprecated. * Added a default exponential backoff implementation, for easy use of internal callers. Added a new backoff package which defines the backoff configuration options, and is used by both the grpc package and the internal/backoff package. This allows us to have all backoff related options in a separate package.
59 lines
1.9 KiB
Go
59 lines
1.9 KiB
Go
/*
|
|
*
|
|
* Copyright 2017 gRPC authors.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
*/
|
|
|
|
// See internal/backoff package for the backoff implementation. This file is
|
|
// kept for the exported types and API backward compatibility.
|
|
|
|
package grpc
|
|
|
|
import (
|
|
"time"
|
|
|
|
"google.golang.org/grpc/backoff"
|
|
)
|
|
|
|
// DefaultBackoffConfig uses values specified for backoff in
|
|
// https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.
|
|
//
|
|
// Deprecated: use ConnectParams instead. Will be supported throughout 1.x.
|
|
var DefaultBackoffConfig = BackoffConfig{
|
|
MaxDelay: 120 * time.Second,
|
|
}
|
|
|
|
// BackoffConfig defines the parameters for the default gRPC backoff strategy.
|
|
//
|
|
// Deprecated: use ConnectParams instead. Will be supported throughout 1.x.
|
|
type BackoffConfig struct {
|
|
// MaxDelay is the upper bound of backoff delay.
|
|
MaxDelay time.Duration
|
|
}
|
|
|
|
// ConnectParams defines the parameters for connecting and retrying. Users are
|
|
// encouraged to use this instead of the BackoffConfig type defined above. See
|
|
// here for more details:
|
|
// https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.
|
|
//
|
|
// This API is EXPERIMENTAL.
|
|
type ConnectParams struct {
|
|
// Backoff specifies the configuration options for connection backoff.
|
|
Backoff backoff.Config
|
|
// MinConnectTimeout is the minimum amount of time we are willing to give a
|
|
// connection to complete.
|
|
MinConnectTimeout time.Duration
|
|
}
|