/
doc.go
51 lines (50 loc) · 2.28 KB
/
doc.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
// 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 peerlist provides a utility for managing peer availability with a
// separate implementation of peer selection from just among available peers.
// The peer list implements the peer.ChooserList interface and accepts a
// peerlist.Implementation to provide the implementation-specific concern of,
// for example, a *roundrobin.List.
//
// The example is an implementation of peer.ChooserList using a random peer selection
// strategy, returned by newRandomListImplementation(), implementing
// peerlist.Implementation.
//
// type List struct {
// *peerlist.List
// }
//
// func New(transport peer.Transport) *List {
// return &List{
// List: peerlist.New(
// "random",
// transport,
// newRandomListImplementation(),
// ),
// }
// }
//
// The abstract peer list is designed to take responsibility for concurrently
// communicating with three parties: the outbound (which sees it as a
// peer.Chooser), the peer list updater (which see it as a peer.List), and the
// transport (which sees it as a bank of peer.Subscriber).
// By taking care of concurrency, the abstract peer list frees the
// Implementation from the concern of thread safety.
package peerlist