go.uber.org/yarpc@v1.72.1/x/yarpctest/types/request.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 types
    22  
    23  import (
    24  	"go.uber.org/yarpc/api/peer"
    25  	"go.uber.org/yarpc/x/yarpctest/api"
    26  )
    27  
    28  // Service is a concrete type that represents the "service" for a request.
    29  // It can be used in multiple interfaces.
    30  type Service struct {
    31  	Service string
    32  }
    33  
    34  // ApplyRequest implements api.RequestOption
    35  func (n *Service) ApplyRequest(opts *api.RequestOpts) {
    36  	opts.GiveRequest.Service = n.Service
    37  }
    38  
    39  // ApplyClientStreamRequest implements api.ClientStreamRequestOption
    40  func (n *Service) ApplyClientStreamRequest(opts *api.ClientStreamRequestOpts) {
    41  	opts.GiveRequest.Meta.Service = n.Service
    42  }
    43  
    44  // Procedure is a concrete type that represents the "procedure" for a request.
    45  // It can be used in multiple interfaces.
    46  type Procedure struct {
    47  	Procedure string
    48  }
    49  
    50  // ApplyRequest implements api.RequestOption
    51  func (n *Procedure) ApplyRequest(opts *api.RequestOpts) {
    52  	opts.GiveRequest.Procedure = n.Procedure
    53  }
    54  
    55  // ApplyClientStreamRequest implements api.ClientStreamRequestOption
    56  func (n *Procedure) ApplyClientStreamRequest(opts *api.ClientStreamRequestOpts) {
    57  	opts.GiveRequest.Meta.Procedure = n.Procedure
    58  }
    59  
    60  // ShardKey is a concrete type that represents the "shard key" for a request.
    61  // It can be used in multiple interfaces.
    62  type ShardKey struct {
    63  	ShardKey string
    64  }
    65  
    66  // ApplyRequest implements api.RequestOption
    67  func (n *ShardKey) ApplyRequest(opts *api.RequestOpts) {
    68  	opts.GiveRequest.ShardKey = n.ShardKey
    69  }
    70  
    71  // ApplyClientStreamRequest implements api.ClientStreamRequestOption
    72  func (n *ShardKey) ApplyClientStreamRequest(opts *api.ClientStreamRequestOpts) {
    73  	opts.GiveRequest.Meta.ShardKey = n.ShardKey
    74  }
    75  
    76  // ChooserFactory is a concrete type that providers the peer chooser for the
    77  // request.
    78  type ChooserFactory struct {
    79  	NewChooser func(peer.Identifier, peer.Transport) (peer.Chooser, error)
    80  }
    81  
    82  // ApplyClientStreamRequest implements api.ClientStreamRequestOption
    83  func (n *ChooserFactory) ApplyClientStreamRequest(opts *api.ClientStreamRequestOpts) {
    84  	opts.NewChooser = n.NewChooser
    85  }