cmd/bpa-operator/vendor/google.golang.org/grpc/internal/internal.go

   1 /*
   2  * Copyright 2016 gRPC authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // Package internal contains gRPC-internal code, to avoid polluting
  19 // the godoc of the top-level grpc package.  It must not import any grpc
  20 // symbols to avoid circular dependencies.
  21 package internal
  22
  23 import (
  24         "context"
  25         "time"
  26 )
  27
  28 var (
  29         // WithResolverBuilder is exported by dialoptions.go
  30         WithResolverBuilder interface{} // func (resolver.Builder) grpc.DialOption
  31         // WithHealthCheckFunc is not exported by dialoptions.go
  32         WithHealthCheckFunc interface{} // func (HealthChecker) DialOption
  33         // HealthCheckFunc is used to provide client-side LB channel health checking
  34         HealthCheckFunc HealthChecker
  35         // BalancerUnregister is exported by package balancer to unregister a balancer.
  36         BalancerUnregister func(name string)
  37         // KeepaliveMinPingTime is the minimum ping interval.  This must be 10s by
  38         // default, but tests may wish to set it lower for convenience.
  39         KeepaliveMinPingTime = 10 * time.Second
  40 )
  41
  42 // HealthChecker defines the signature of the client-side LB channel health checking function.
  43 type HealthChecker func(ctx context.Context, newStream func() (interface{}, error), reportHealth func(bool), serviceName string) error
  44
  45 const (
  46         // CredsBundleModeFallback switches GoogleDefaultCreds to fallback mode.
  47         CredsBundleModeFallback = "fallback"
  48         // CredsBundleModeBalancer switches GoogleDefaultCreds to grpclb balancer
  49         // mode.
  50         CredsBundleModeBalancer = "balancer"
  51         // CredsBundleModeBackendFromBalancer switches GoogleDefaultCreds to mode
  52         // that supports backend returned by grpclb balancer.
  53         CredsBundleModeBackendFromBalancer = "backend-from-balancer"
  54 )