blob: 0912f0bf4c311daeee0bad8109755b1b446b8f85 [file] [log] [blame]
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +00001/*
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 (
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +000031 // WithHealthCheckFunc is set 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 // StatusRawProto is exported by status/status.go. This func returns a
41 // pointer to the wrapped Status proto for a given status.Status without a
42 // call to proto.Clone(). The returned Status proto should not be mutated by
43 // the caller.
44 StatusRawProto interface{} // func (*status.Status) *spb.Status
45 // NewRequestInfoContext creates a new context based on the argument context attaching
46 // the passed in RequestInfo to the new context.
47 NewRequestInfoContext interface{} // func(context.Context, credentials.RequestInfo) context.Context
48 // ParseServiceConfigForTesting is for creating a fake
49 // ClientConn for resolver testing only
50 ParseServiceConfigForTesting interface{} // func(string) *serviceconfig.ParseResult
51)
52
53// HealthChecker defines the signature of the client-side LB channel health checking function.
54//
55// The implementation is expected to create a health checking RPC stream by
56// calling newStream(), watch for the health status of serviceName, and report
57// it's health back by calling setConnectivityState().
58//
59// The health checking protocol is defined at:
60// https://github.com/grpc/grpc/blob/master/doc/health-checking.md
Dinesh Belwalkar396b6522020-02-06 22:11:53 +000061type HealthChecker func(ctx context.Context, newStream func(string) (interface{}, error), setConnectivityState func(connectivity.State, error), serviceName string) error
Dinesh Belwalkare63f7f92019-11-22 23:11:16 +000062
63const (
64 // CredsBundleModeFallback switches GoogleDefaultCreds to fallback mode.
65 CredsBundleModeFallback = "fallback"
66 // CredsBundleModeBalancer switches GoogleDefaultCreds to grpclb balancer
67 // mode.
68 CredsBundleModeBalancer = "balancer"
69 // CredsBundleModeBackendFromBalancer switches GoogleDefaultCreds to mode
70 // that supports backend returned by grpclb balancer.
71 CredsBundleModeBackendFromBalancer = "backend-from-balancer"
72)