blob: eaa54d4fc628a4efe4867ed98542aad7ca323a31 [file] [log] [blame]
khenaidooac637102019-01-14 15:44:34 -05001/*
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.
21package internal
22
23import "context"
24
25var (
Stephane Barbarie260a5632019-02-26 16:12:49 -050026 // WithContextDialer is exported by dialoptions.go
khenaidooac637102019-01-14 15:44:34 -050027 WithContextDialer interface{} // func(context.Context, string) (net.Conn, error) grpc.DialOption
Stephane Barbarie260a5632019-02-26 16:12:49 -050028 // WithResolverBuilder is exported by dialoptions.go
khenaidooac637102019-01-14 15:44:34 -050029 WithResolverBuilder interface{} // func (resolver.Builder) grpc.DialOption
Stephane Barbarie260a5632019-02-26 16:12:49 -050030 // WithHealthCheckFunc is not exported by dialoptions.go
31 WithHealthCheckFunc interface{} // func (HealthChecker) DialOption
khenaidooac637102019-01-14 15:44:34 -050032 // HealthCheckFunc is used to provide client-side LB channel health checking
Stephane Barbarie260a5632019-02-26 16:12:49 -050033 HealthCheckFunc HealthChecker
34 // BalancerUnregister is exported by package balancer to unregister a balancer.
35 BalancerUnregister func(name string)
khenaidooac637102019-01-14 15:44:34 -050036)
37
Stephane Barbarie260a5632019-02-26 16:12:49 -050038// HealthChecker defines the signature of the client-side LB channel health checking function.
39type HealthChecker func(ctx context.Context, newStream func() (interface{}, error), reportHealth func(bool), serviceName string) error
40
khenaidooac637102019-01-14 15:44:34 -050041const (
42 // CredsBundleModeFallback switches GoogleDefaultCreds to fallback mode.
43 CredsBundleModeFallback = "fallback"
44 // CredsBundleModeBalancer switches GoogleDefaultCreds to grpclb balancer
45 // mode.
46 CredsBundleModeBalancer = "balancer"
47 // CredsBundleModeBackendFromBalancer switches GoogleDefaultCreds to mode
48 // that supports backend returned by grpclb balancer.
49 CredsBundleModeBackendFromBalancer = "backend-from-balancer"
50)