blob: bda4309c03a58623c572b8cde3f816ffface73f7 [file] [log] [blame]
Serge Bazanskicc25bdf2018-10-25 14:02:58 +02001/*
2 *
3 * Copyright 2017 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19package grpc
20
21import (
22 "golang.org/x/net/context"
23 "google.golang.org/grpc/balancer"
24 "google.golang.org/grpc/connectivity"
25 "google.golang.org/grpc/grpclog"
26 "google.golang.org/grpc/resolver"
27)
28
29// PickFirstBalancerName is the name of the pick_first balancer.
30const PickFirstBalancerName = "pick_first"
31
32func newPickfirstBuilder() balancer.Builder {
33 return &pickfirstBuilder{}
34}
35
36type pickfirstBuilder struct{}
37
38func (*pickfirstBuilder) Build(cc balancer.ClientConn, opt balancer.BuildOptions) balancer.Balancer {
39 return &pickfirstBalancer{cc: cc}
40}
41
42func (*pickfirstBuilder) Name() string {
43 return PickFirstBalancerName
44}
45
46type pickfirstBalancer struct {
47 cc balancer.ClientConn
48 sc balancer.SubConn
49}
50
51func (b *pickfirstBalancer) HandleResolvedAddrs(addrs []resolver.Address, err error) {
52 if err != nil {
53 grpclog.Infof("pickfirstBalancer: HandleResolvedAddrs called with error %v", err)
54 return
55 }
56 if b.sc == nil {
57 b.sc, err = b.cc.NewSubConn(addrs, balancer.NewSubConnOptions{})
58 if err != nil {
59 //TODO(yuxuanli): why not change the cc state to Idle?
60 grpclog.Errorf("pickfirstBalancer: failed to NewSubConn: %v", err)
61 return
62 }
63 b.cc.UpdateBalancerState(connectivity.Idle, &picker{sc: b.sc})
64 b.sc.Connect()
65 } else {
66 b.sc.UpdateAddresses(addrs)
67 b.sc.Connect()
68 }
69}
70
71func (b *pickfirstBalancer) HandleSubConnStateChange(sc balancer.SubConn, s connectivity.State) {
72 grpclog.Infof("pickfirstBalancer: HandleSubConnStateChange: %p, %v", sc, s)
73 if b.sc != sc {
74 grpclog.Infof("pickfirstBalancer: ignored state change because sc is not recognized")
75 return
76 }
77 if s == connectivity.Shutdown {
78 b.sc = nil
79 return
80 }
81
82 switch s {
83 case connectivity.Ready, connectivity.Idle:
84 b.cc.UpdateBalancerState(s, &picker{sc: sc})
85 case connectivity.Connecting:
86 b.cc.UpdateBalancerState(s, &picker{err: balancer.ErrNoSubConnAvailable})
87 case connectivity.TransientFailure:
88 b.cc.UpdateBalancerState(s, &picker{err: balancer.ErrTransientFailure})
89 }
90}
91
92func (b *pickfirstBalancer) Close() {
93}
94
95type picker struct {
96 err error
97 sc balancer.SubConn
98}
99
100func (p *picker) Pick(ctx context.Context, opts balancer.PickOptions) (balancer.SubConn, func(balancer.DoneInfo), error) {
101 if p.err != nil {
102 return nil, nil, p.err
103 }
104 return p.sc, nil, nil
105}
106
107func init() {
108 balancer.Register(newPickfirstBuilder())
109}