go.uber.org/yarpc@v1.72.1/transport/tchannel/channel.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 tchannel
    22  
    23  import (
    24  	"github.com/uber/tchannel-go"
    25  	"golang.org/x/net/context"
    26  )
    27  
    28  // Channel is the interface exposed by TChannel. The TChannel transport for
    29  // YARPC is built on top of this interface.
    30  //
    31  // See https://godoc.org/github.com/uber/tchannel-go#Channel for more
    32  // information about these methods.
    33  type Channel interface {
    34  	BeginCall(
    35  		ctx context.Context,
    36  		hostPort, serviceName, methodName string,
    37  		callOptions *tchannel.CallOptions,
    38  	) (*tchannel.OutboundCall, error)
    39  	Close()
    40  	GetSubChannel(serviceName string, opts ...tchannel.SubChannelOption) *tchannel.SubChannel
    41  	ListenAndServe(hostPort string) error
    42  	PeerInfo() tchannel.LocalPeerInfo
    43  	RootPeers() *tchannel.RootPeerList
    44  	ServiceName() string
    45  	State() tchannel.ChannelState
    46  }
    47  
    48  var _ Channel = (*tchannel.Channel)(nil)