go.uber.org/yarpc@v1.72.1/peer/direct/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 direct
    22  
    23  import (
    24  	"go.uber.org/yarpc/api/peer"
    25  	"go.uber.org/yarpc/yarpcconfig"
    26  )
    27  
    28  const name = "direct"
    29  
    30  // Configuration describes how to build a direct peer chooser.
    31  type Configuration struct{}
    32  
    33  // Spec returns a configuration specification for the direct peer chooser. The
    34  // chooser uses transport.Request#ShardKey as the peer dentifier.
    35  //
    36  //  cfg := yarpcconfig.New()
    37  //  cfg.MustRegisterPeerChooser(direct.Spec())
    38  //
    39  // This enables the direct chooser:
    40  //
    41  //  outbounds:
    42  //    destination-service:
    43  //      grpc:
    44  //        direct: {}
    45  func Spec(opts ...ChooserOption) yarpcconfig.PeerChooserSpec {
    46  	return yarpcconfig.PeerChooserSpec{
    47  		Name: name,
    48  		BuildPeerChooser: func(cfg Configuration, t peer.Transport, _ *yarpcconfig.Kit) (peer.Chooser, error) {
    49  			return New(cfg, t, opts...)
    50  		},
    51  	}
    52  }