retrier

Documentation

Overview

Example

package main

import (
	"fmt"
	"time"

	"github.com/spoke-d/thermionic/internal/clock"
	"github.com/spoke-d/thermionic/internal/retrier"
)

func main() {
	retry := retrier.New(clock.DefaultSleeper, 10, time.Second)
	err := retry.Run(func() error {
		return nil
	})

	switch {
	case err == nil:
		fmt.Println("success!")
	case retrier.ErrRetry(err):
		fmt.Println("deadline timeout")
	default:
		fmt.Println("other error")
	}

}

Output:

success!

Index

• func ErrRetry(err error) bool
• type Retrier
  • func New(sleeper clock.Sleeper, amount int, duration time.Duration) *Retrier
  • func (r *Retrier) Run(fn func() error) error

Examples

• Package

Functions

func ErrRetry

func ErrRetry(err error) bool

ErrRetry checks if the error was because of too many retries.

Types

type Retrier

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

Retrier encapsulates the mechanism around retrying function

func New

func New(sleeper clock.Sleeper, amount int, duration time.Duration) *Retrier

New creates a Retrier with sane defaults

func (*Retrier) Run

func (r *Retrier) Run(fn func() error) error

Run executes the given function