go.uber.org/yarpc@v1.72.1/api/x/introspection/outbound.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 introspection
    22  
    23  // IntrospectableOutbound extends the Outbound interface.
    24  type IntrospectableOutbound interface {
    25  	Introspect() OutboundStatus
    26  }
    27  
    28  // OutboundStatus is a collection of basics info about an Outbound.
    29  type OutboundStatus struct {
    30  	Transport   string        `json:"transport"`
    31  	RPCType     string        `json:"rpctype"`
    32  	Endpoint    string        `json:"endpoint"`
    33  	State       string        `json:"state"`
    34  	Chooser     ChooserStatus `json:"chooser"`
    35  	Service     string        `json:"service"`
    36  	OutboundKey string        `json:"outboundkey"`
    37  }
    38  
    39  // OutboundStatusNotSupported is returned when not valid OutboundStatus can be
    40  // produced.
    41  var OutboundStatusNotSupported = OutboundStatus{}