go.uber.org/yarpc@v1.72.1/x/yarpctest/api/handler_stream.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  	"testing"
    25  
    26  	"go.uber.org/yarpc/api/transport"
    27  )
    28  
    29  // ServerStreamAction is an action applied to a ServerStream.
    30  // If the action returns an error, that error will be used to end the ServerStream.
    31  type ServerStreamAction interface {
    32  	Lifecycle
    33  
    34  	ApplyServerStream(*transport.ServerStream) error
    35  }
    36  
    37  // ServerStreamActionFunc converts a function into a StreamAction.
    38  type ServerStreamActionFunc func(*transport.ServerStream) error
    39  
    40  // ApplyServerStream implements ServerStreamAction.
    41  func (f ServerStreamActionFunc) ApplyServerStream(c *transport.ServerStream) error { return f(c) }
    42  
    43  // Start is a noop for wrapped functions
    44  func (f ServerStreamActionFunc) Start(testing.TB) error { return nil }
    45  
    46  // Stop is a noop for wrapped functions
    47  func (f ServerStreamActionFunc) Stop(testing.TB) error { return nil }