go.uber.org/yarpc@v1.72.1/peer/abstractlist/doc.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  // Package abstractlist provides a utility for managing peer availability with a
    22  // separate implementation of peer selection from just among available peers.
    23  // The peer list implements the peer.ChooserList interface and accepts an
    24  // abstractlist.Implementation to provide the implementation-specific concern of,
    25  // for example, a *roundrobin.List.
    26  //
    27  // The example is an implementation of peer.ChooserList using a random peer selection
    28  // strategy, returned by newRandomListImplementation(), implementing
    29  // abstractlist.Implementation.
    30  //
    31  //   type List struct {
    32  //   	*abstractlist.List
    33  //   }
    34  //
    35  //   func New(transport peer.Transport) *List {
    36  //   	return &List{
    37  //   		List: abstractlist.New(
    38  //   			"random",
    39  //   			transport,
    40  //   			newRandomListImplementation(),
    41  //   		),
    42  //   	}
    43  //   }
    44  //
    45  // The abstract peer list is designed to take responsibility for concurrently
    46  // communicating with three parties: the outbound (which sees it as a
    47  // peer.Chooser), the peer list updater (which see it as a peer.List), and the
    48  // transport (which sees it as a bank of peer.Subscriber).
    49  // By taking care of concurrency, the abstract peer list frees the
    50  // Implementation from the concern of thread safety.
    51  package abstractlist