vendor/google.golang.org/grpc/pickfirst.go

   1 /*
   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
  19 package grpc
  20
  21 import (
  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 func newPickfirstBuilder() balancer.Builder {
  30         return &pickfirstBuilder{}
  31 }
  32
  33 type pickfirstBuilder struct{}
  34
  35 func (*pickfirstBuilder) Build(cc balancer.ClientConn, opt balancer.BuildOptions) balancer.Balancer {
  36         return &pickfirstBalancer{cc: cc}
  37 }
  38
  39 func (*pickfirstBuilder) Name() string {
  40         return "pickfirst"
  41 }
  42
  43 type pickfirstBalancer struct {
  44         cc balancer.ClientConn
  45         sc balancer.SubConn
  46 }
  47
  48 func (b *pickfirstBalancer) HandleResolvedAddrs(addrs []resolver.Address, err error) {
  49         if err != nil {
  50                 grpclog.Infof("pickfirstBalancer: HandleResolvedAddrs called with error %v", err)
  51                 return
  52         }
  53         if b.sc == nil {
  54                 b.sc, err = b.cc.NewSubConn(addrs, balancer.NewSubConnOptions{})
  55                 if err != nil {
  56                         grpclog.Errorf("pickfirstBalancer: failed to NewSubConn: %v", err)
  57                         return
  58                 }
  59                 b.cc.UpdateBalancerState(connectivity.Idle, &picker{sc: b.sc})
  60                 b.sc.Connect()
  61         } else {
  62                 b.sc.UpdateAddresses(addrs)
  63                 b.sc.Connect()
  64         }
  65 }
  66
  67 func (b *pickfirstBalancer) HandleSubConnStateChange(sc balancer.SubConn, s connectivity.State) {
  68         grpclog.Infof("pickfirstBalancer: HandleSubConnStateChange: %p, %v", sc, s)
  69         if b.sc != sc {
  70                 grpclog.Infof("pickfirstBalancer: ignored state change because sc is not recognized")
  71                 return
  72         }
  73         if s == connectivity.Shutdown {
  74                 b.sc = nil
  75                 return
  76         }
  77
  78         switch s {
  79         case connectivity.Ready, connectivity.Idle:
  80                 b.cc.UpdateBalancerState(s, &picker{sc: sc})
  81         case connectivity.Connecting:
  82                 b.cc.UpdateBalancerState(s, &picker{err: balancer.ErrNoSubConnAvailable})
  83         case connectivity.TransientFailure:
  84                 b.cc.UpdateBalancerState(s, &picker{err: balancer.ErrTransientFailure})
  85         }
  86 }
  87
  88 func (b *pickfirstBalancer) Close() {
  89 }
  90
  91 type picker struct {
  92         err error
  93         sc  balancer.SubConn
  94 }
  95
  96 func (p *picker) Pick(ctx context.Context, opts balancer.PickOptions) (balancer.SubConn, func(balancer.DoneInfo), error) {
  97         if p.err != nil {
  98                 return nil, nil, p.err
  99         }
 100         return p.sc, nil, nil
 101 }
 102
 103 func init() {
 104         balancer.Register(newPickfirstBuilder())
 105 }