Awesome Go

retry

CategoryUtilities
SubcategoryUtilities
Stars0

Simple and easy retry mechanism package for Go

About retry

Retry

Build Status Project status Go Report Card Coverage Status GoDoc License

Simple and easy retry mechanism package for Go

Installation

Install the package using

$ go get github.com/thedevsaddam/retry

Usage

To use the package import it in your *.go code

import "github.com/thedevsaddam/retry"

Example

Simply retry a function to execute for max 10 times with interval of 1 second


package main

import (
	"fmt"
	"time"

	"github.com/thedevsaddam/retry"
)

func main() {
	i := 1 // lets assume we expect i to be a value of 8
	err := retry.DoFunc(10, 1*time.Second, func() error {
		fmt.Printf("trying for: %dth time\n", i)
		i++
		if i > 7 {
			return nil
		}
		return fmt.Errorf("i = %d is still low value", i)
	})

	if err != nil {
		panic(err)
	}

	fmt.Println("Got our expected result: ", i)
}

We can execute function from other package with arguments and return values


package main

import (
	"errors"
	"log"
	"time"

	"github.com/thedevsaddam/retry"
)

func div(a, b float64) (float64, error) {
	if b == 0 {
		return 0, errors.New("Can not divide by zero")
	}
	return a / b, nil
}

func main() {
	a := 20.6
	b := 3.7 // if we assign 0.0 to b, it will cause an error and will retry for 3 times
	res, err := retry.Do(3, 5*time.Second, div, a, b)
	if err != nil {
		panic(err)
	}
	log.Println(res)
}

Contribution

If you are interested to make the package better please send pull requests or create an issue so that others can fix. Read the contribution guide here.

License

The retry is an open-source software licensed under the MIT License.

Frequently Asked Questions

What is retry?

retry is a Utilities library for the Go programming language. Simple and easy retry mechanism package for Go

How do I install retry?

Install retry with the Go module system using `go get thedevsaddam/retry`. Check the repository for the current installation instructions.

What category does retry belong to?

retry is listed under Utilities, specifically Utilities.

← Back to Utilities