go.uber.org/yarpc@v1.72.1/peer/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 peer contains components for managing peers.
    22  //
    23  // The `go.uber.org/yarpc/api/peer` package provides the corresponding
    24  // interfaces that these components implement.
    25  //
    26  // The HTTP and TChannel `NewOutbound` methods accept a `peer.Chooser`.
    27  // To bind an outbound to a single peer, pass a `peer.NewSingle(id)`.
    28  //
    29  // To bind an outbound to multiple peers, you will need a peer list, like
    30  // `roundrobin` (to pick the least recently chosen peer) or `peerheap` (to
    31  // choose the peer with the fewest pending requests).
    32  // Assuming you choose `peerheap`, to bind multiple peers you would pass
    33  // `peer.Bind(peerheap.New(transport), peer.BindPeers(ids))`.
    34  //
    35  // Each transport can define its own domain of peer identifiers, but most will
    36  // use a host:port address for the remote listening socket.
    37  // The `"go.uber.org/yarpc/peer/hostport"` package implements the common
    38  // `hostport.PeerIdentifier` and `hostport.Peer`.
    39  package peer