go.uber.org/yarpc@v1.72.1/x/yarpctest/api/service.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 api
    22  
    23  import (
    24  	"net"
    25  	"testing"
    26  
    27  	"go.uber.org/yarpc/api/transport"
    28  )
    29  
    30  // ServiceOpts are the configuration options for a yarpc service.
    31  type ServiceOpts struct {
    32  	Name       string
    33  	Listener   net.Listener
    34  	Port       uint16
    35  	Procedures []transport.Procedure
    36  }
    37  
    38  // ServiceOption is an option when creating a Service.
    39  type ServiceOption interface {
    40  	Lifecycle
    41  
    42  	ApplyService(*ServiceOpts)
    43  }
    44  
    45  // ServiceOptionFunc converts a function into a ServiceOption.
    46  type ServiceOptionFunc func(*ServiceOpts)
    47  
    48  // ApplyService implements ServiceOption.
    49  func (f ServiceOptionFunc) ApplyService(opts *ServiceOpts) { f(opts) }
    50  
    51  // Start is a noop for wrapped functions
    52  func (f ServiceOptionFunc) Start(testing.TB) error { return nil }
    53  
    54  // Stop is a noop for wrapped functions
    55  func (f ServiceOptionFunc) Stop(testing.TB) error { return nil }