/
config.go
90 lines (81 loc) · 3.08 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// Copyright (c) 2022 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package randpeer
import (
"fmt"
"time"
"go.uber.org/yarpc/api/peer"
"go.uber.org/yarpc/yarpcconfig"
"go.uber.org/yarpc/yarpcerrors"
)
// Configuration descripes how to build a random peer list.
type Configuration struct {
Capacity *int `config:"capacity"`
FailFast bool `config:"failFast"`
// DefaultChooseTimeout specifies the deadline to add to Choose calls if not
// present. This enables calls without deadlines, ie streaming, to choose
// peers without waiting indefinitely.
DefaultChooseTimeout *time.Duration `config:"defaultChooseTimeout"`
}
// Spec returns a configuration specification for the random peer list
// implementation, making it possible to select a random peer with transports
// that use outbound peer list configuration (like HTTP).
//
// cfg := yarpcconfig.New()
// cfg.MustRegisterPeerList(random.Spec())
//
// This enables the random peer list:
//
// outbounds:
// otherservice:
// unary:
// http:
// url: https://host:port/rpc
// random:
// peers:
// - 127.0.0.1:8080
// - 127.0.0.1:8081
func Spec() yarpcconfig.PeerListSpec {
return SpecWithOptions()
}
// SpecWithOptions accepts additional list constructor options.
func SpecWithOptions(options ...ListOption) yarpcconfig.PeerListSpec {
return yarpcconfig.PeerListSpec{
Name: "random",
BuildPeerList: func(cfg Configuration, t peer.Transport, k *yarpcconfig.Kit) (peer.ChooserList, error) {
opts := make([]ListOption, 0, len(options)+2)
opts = append(opts, options...)
if cfg.Capacity != nil {
if *cfg.Capacity <= 0 {
return nil, yarpcerrors.Newf(yarpcerrors.CodeInvalidArgument,
fmt.Sprintf("Capacity must be greater than 0. Got: %d.", *cfg.Capacity))
}
opts = append(opts, Capacity(*cfg.Capacity))
}
if cfg.FailFast {
opts = append(opts, FailFast())
}
if cfg.DefaultChooseTimeout != nil {
opts = append(opts, DefaultChooseTimeout(*cfg.DefaultChooseTimeout))
}
return New(t, opts...), nil
},
}
}