go.uber.org/yarpc@v1.72.1/api/transport/lifecycle.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 transport
    22  
    23  // Lifecycle objects are used to define a common Start/Stop functionality
    24  // across different transport objects.
    25  type Lifecycle interface {
    26  	// Start the lifecycle object, returns an error if it cannot be started.
    27  	// Start MUST be idempotent.
    28  	Start() error
    29  
    30  	// Stop the lifecycle object, returns an error if it cannot be stopped.
    31  	// Stop MUST be idempotent.
    32  	Stop() error
    33  
    34  	// IsRunning returns whether the Lifecycle is currently running.
    35  	//
    36  	// This function exists for introspection purposes only. It should not be
    37  	// used to assert the state of the lifecycle.
    38  	IsRunning() bool
    39  }