go.uber.org/yarpc@v1.72.1/api/transport/clientconfig.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 transport
    22  
    23  // ClientConfigProvider builds ClientConfigs from the current service to other services.
    24  type ClientConfigProvider interface {
    25  	// Retrieves a new ClientConfig that will make requests to the given service.
    26  	//
    27  	// This MAY panic if the given service is unknown.
    28  	ClientConfig(service string) ClientConfig
    29  }
    30  
    31  // A ClientConfig is a stream of communication between a single caller-service
    32  // pair.
    33  type ClientConfig interface {
    34  	// Name of the service making the request.
    35  	Caller() string
    36  
    37  	// Name of the service to which the request is being made.
    38  	Service() string
    39  
    40  	// Returns an outbound to send the request through or panics if there is no
    41  	// outbound for this service
    42  	//
    43  	// MAY be called multiple times for a request. The returned outbound MUST
    44  	// have already been started.
    45  	GetUnaryOutbound() UnaryOutbound
    46  	GetOnewayOutbound() OnewayOutbound
    47  }