outboundconfig.go

// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package transport

import "fmt"

// OutboundConfig is a configuration for how to call into another service.  It
// is used in conjunction with an encoding to send a request through one of the
// outbounds.
type OutboundConfig struct {
	CallerName string
	Outbounds  Outbounds
}

var _ ClientConfig = (*OutboundConfig)(nil)

// Caller is the name of the service making the request.
//
// Implements ClientConfig#Caller (for backwards compatibility).
func (o *OutboundConfig) Caller() string {
	// TODO: This function should be deprecated, it's for legacy support.
	// Use CallerName instead.
	return o.CallerName
}

// Service is the name of the service to which the request is being made.
//
// Implements ClientConfig#Service (for backwards compatibility).
func (o *OutboundConfig) Service() string {
	// TODO: This function should be deprecated, it's for legacy support.
	// Use Outbounds.ServiceName instead.
	return o.Outbounds.ServiceName
}

// GetUnaryOutbound returns an outbound to send the request through or panics
// if there is no unary outbound for this service.
//
// Implements ClientConfig#GetUnaryOutbound.
func (o *OutboundConfig) GetUnaryOutbound() UnaryOutbound {
	// TODO: This function should be deprecated, it's for legacy support.
	// Use Outbounds.Unary instead (and panic if you want).
	if o.Outbounds.Unary == nil {
		panic(fmt.Sprintf("service %q does not have a unary outbound", o.Outbounds.ServiceName))
	}
	return o.Outbounds.Unary
}

// GetOnewayOutbound returns an outbound to send the request through or panics
// if there is no oneway outbound for this service.
//
// Implements ClientConfig#GetOnewayOutbound.
func (o *OutboundConfig) GetOnewayOutbound() OnewayOutbound {
	// TODO: This function should be deprecated, it's for legacy support.
	// Use o.Outbounds.Oneway instead (and panic if you want).
	if o.Outbounds.Oneway == nil {
		panic(fmt.Sprintf("service %q does not have a oneway outbound", o.Outbounds.ServiceName))
	}
	return o.Outbounds.Oneway
}