go.uber.org/yarpc@v1.72.1/peer/x/peerheap/config.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 peerheap
    22  
    23  import (
    24  	"go.uber.org/yarpc/api/peer"
    25  	"go.uber.org/yarpc/yarpcconfig"
    26  )
    27  
    28  // Spec returns a configuration specification for the least-pending peer heap
    29  // peer chooser implementation, making it possible to select the least pending
    30  // peer with transports that use outbound peer list configuration (like HTTP).
    31  //
    32  //  cfg := yarpcconfig.New()
    33  //  cfg.MustRegisterPeerList(peerheap.Spec())
    34  //
    35  // This enables the least-pending peer list:
    36  //
    37  //  outbounds:
    38  //    otherservice:
    39  //      unary:
    40  //        http:
    41  //          url: https://host:port/rpc
    42  //          least-pending:
    43  //            peers:
    44  //              - 127.0.0.1:8080
    45  //              - 127.0.0.1:8081
    46  func Spec() yarpcconfig.PeerListSpec {
    47  	return yarpcconfig.PeerListSpec{
    48  		Name: "least-pending",
    49  		BuildPeerList: func(c struct{}, t peer.Transport, k *yarpcconfig.Kit) (peer.ChooserList, error) {
    50  			return New(t), nil
    51  		},
    52  	}
    53  }