go.uber.org/yarpc@v1.72.1/api/backoff/backoff.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 backoff
    22  
    23  import "time"
    24  
    25  // Strategy is a factory for backoff algorithms.
    26  // Each backoff instance may capture some state, typically a random number
    27  // generator.
    28  // The strategy guarantees that these backoff instances are either
    29  // referentially independent and lockless or thread safe.
    30  //
    31  // Backoff strategies are useful for configuring retry loops, balancing the
    32  // need to recover quickly against denial of service as a failure mode.
    33  type Strategy interface {
    34  	Backoff() Backoff
    35  }
    36  
    37  // Backoff is an algorithm for determining how long to wait after a number of
    38  // attempts to perform some action.
    39  // Backoff strategies typically use a random number generator that uses some
    40  // state for feedback.
    41  // Instances of backoff are intended to be used in the stack of a single
    42  // goroutine and must therefore either be referentially independent or lock
    43  // safe.
    44  type Backoff interface {
    45  	Duration(attempts uint) time.Duration
    46  }