backo

README

Backo

Note
Segment has paused maintenance on this project, but may return it to an active status in the future. Issues and pull requests from external contributors are not being considered, although internal contributions may appear from time to time. The project remains available under its open source license for anyone to use.

Exponential backoff for Go (Go port of segmentio/backo).

Usage

import "github.com/segmentio/backo-go"

// Create a Backo instance.
backo := backo.NewBacko(milliseconds(100), 2, 1, milliseconds(10*1000))
// OR with defaults.
backo := backo.DefaultBacko()

// Use the ticker API.
ticker := b.NewTicker()
for {
    timeout := time.After(5 * time.Minute)
    select {
    case  <-ticker.C:
        fmt.Println("ticked")
    case <- timeout:
        fmt.Println("timed out")
    }
}

// Or simply work with backoff intervals directly.
for i := 0; i < n; i++ {
    // Sleep the current goroutine.
    backo.Sleep(i)
    // Retrieve the duration manually.
    duration := backo.Duration(i)
}

License

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

The MIT License (MIT)

Copyright (c) 2015 Segment, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

• type Backo
  • func DefaultBacko() *Backo
  • func NewBacko(base time.Duration, factor uint8, jitter float64, cap time.Duration) *Backo
  • func (backo *Backo) Duration(attempt int) time.Duration
  • func (b *Backo) NewTicker() *Ticker
  • func (backo *Backo) Sleep(attempt int)
• type Ticker
  • func (t *Ticker) Stop()

Types

type Backo

type Backo struct {
	// contains filtered or unexported fields
}

func DefaultBacko

func DefaultBacko() *Backo

Creates a backo instance with the following defaults:

base: 100 milliseconds
factor: 2
jitter: 0
cap: 10 seconds

func NewBacko

func NewBacko(base time.Duration, factor uint8, jitter float64, cap time.Duration) *Backo

Creates a backo instance with the given parameters

func (*Backo) Duration

func (backo *Backo) Duration(attempt int) time.Duration

Duration returns the backoff interval for the given attempt.

func (*Backo) NewTicker

func (b *Backo) NewTicker() *Ticker

func (*Backo) Sleep

func (backo *Backo) Sleep(attempt int)

Sleep pauses the current goroutine for the backoff interval for the given attempt.

type Ticker

type Ticker struct {
	C <-chan time.Time
	// contains filtered or unexported fields
}

func (*Ticker) Stop

func (t *Ticker) Stop()