go.uber.org/yarpc@v1.72.1/pkg/lifecycletest/nop.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 lifecycletest
    22  
    23  import "go.uber.org/yarpc/pkg/lifecycle"
    24  
    25  // NewNop returns a new one-time no-op lifecycle.
    26  func NewNop() *Nop {
    27  	return &Nop{once: lifecycle.NewOnce()}
    28  }
    29  
    30  // Nop is a no-op implementation of a lifecycle Once. It advances state but
    31  // performs no actions.
    32  type Nop struct {
    33  	once *lifecycle.Once
    34  }
    35  
    36  // Start advances the Nop to Running without side-effects.
    37  func (n *Nop) Start() error {
    38  	return n.once.Start(nil)
    39  }
    40  
    41  // Stop advances the Nop to Stopped without side-effects.
    42  func (n *Nop) Stop() error {
    43  	return n.once.Stop(nil)
    44  }
    45  
    46  // IsRunning returns the Nop lifecycle.Status.
    47  func (n *Nop) IsRunning() bool {
    48  	return n.once.IsRunning()
    49  }