gentle

README

gentle

About

Go (golang) package for generically encapsulating cancellable retry and gentle retry behaviors.

Created by Jay Taylor and used by Gigawatt.

Requirements

• Go version 1.3 or newer

Running the test suite

go test ./...

License

Permissive MIT license, see the LICENSE file for more information.

Documentation

Index

• func CancellableRetry(config CancellableRetryConfig) (cancelFunc func() error)
• func RetryUntilSuccess(name string, operation func() error, strategy backoff.BackOff)
• type Action
• type CancellableRetryConfig
  • func (config CancellableRetryConfig) ActionNames() string

Functions

func CancellableRetry

func CancellableRetry(config CancellableRetryConfig) (cancelFunc func() error)

func RetryUntilSuccess

func RetryUntilSuccess(name string, operation func() error, strategy backoff.BackOff)

retryUntilSuccess will keep attempting an operation until it succeeds.

Exponential backoff is used to prevent failing attempts from looping madly.

Types

type Action

type Action struct {
	Name string
	Func func() error
}

type CancellableRetryConfig

type CancellableRetryConfig struct {
	Actions         []Action
	DoneChan        chan struct{}
	BackoffProvider func() backoff.BackOff
	Debug           bool
	Quiet           bool
}

func (CancellableRetryConfig) ActionNames

func (config CancellableRetryConfig) ActionNames() string