blob: b96b3597caa1e61787e334a3dfe919477130e082 [file] [log] [blame]
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -07001/*
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 (
24 "context"
25 "time"
26
27 "google.golang.org/grpc/connectivity"
28)
29
30var (
David K. Bainbridgec415efe2021-08-19 13:05:21 +000031 // WithResolverBuilder is set by dialoptions.go
32 WithResolverBuilder interface{} // func (resolver.Builder) grpc.DialOption
Arjun E K57a7fcb2020-01-30 06:44:45 +000033 // WithHealthCheckFunc is set by dialoptions.go
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070034 WithHealthCheckFunc interface{} // func (HealthChecker) DialOption
35 // HealthCheckFunc is used to provide client-side LB channel health checking
36 HealthCheckFunc HealthChecker
37 // BalancerUnregister is exported by package balancer to unregister a balancer.
38 BalancerUnregister func(name string)
39 // KeepaliveMinPingTime is the minimum ping interval. This must be 10s by
40 // default, but tests may wish to set it lower for convenience.
41 KeepaliveMinPingTime = 10 * time.Second
David K. Bainbridgec415efe2021-08-19 13:05:21 +000042 // StatusRawProto is exported by status/status.go. This func returns a
43 // pointer to the wrapped Status proto for a given status.Status without a
44 // call to proto.Clone(). The returned Status proto should not be mutated by
45 // the caller.
46 StatusRawProto interface{} // func (*status.Status) *spb.Status
Arjun E K57a7fcb2020-01-30 06:44:45 +000047 // NewRequestInfoContext creates a new context based on the argument context attaching
48 // the passed in RequestInfo to the new context.
49 NewRequestInfoContext interface{} // func(context.Context, credentials.RequestInfo) context.Context
50 // ParseServiceConfigForTesting is for creating a fake
51 // ClientConn for resolver testing only
52 ParseServiceConfigForTesting interface{} // func(string) *serviceconfig.ParseResult
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070053)
54
55// HealthChecker defines the signature of the client-side LB channel health checking function.
56//
57// The implementation is expected to create a health checking RPC stream by
58// calling newStream(), watch for the health status of serviceName, and report
59// it's health back by calling setConnectivityState().
60//
61// The health checking protocol is defined at:
62// https://github.com/grpc/grpc/blob/master/doc/health-checking.md
David K. Bainbridgec415efe2021-08-19 13:05:21 +000063type HealthChecker func(ctx context.Context, newStream func(string) (interface{}, error), setConnectivityState func(connectivity.State), serviceName string) error
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070064
65const (
66 // CredsBundleModeFallback switches GoogleDefaultCreds to fallback mode.
67 CredsBundleModeFallback = "fallback"
68 // CredsBundleModeBalancer switches GoogleDefaultCreds to grpclb balancer
69 // mode.
70 CredsBundleModeBalancer = "balancer"
71 // CredsBundleModeBackendFromBalancer switches GoogleDefaultCreds to mode
72 // that supports backend returned by grpclb balancer.
73 CredsBundleModeBackendFromBalancer = "backend-from-balancer"
74)