retry

README

Retry

Provide some retry policies to call a function, supporting Go1.7+.

Installation

$ go get -u github.com/xgfone/go-retry

Example

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/xgfone/go-retry"
)

func main() {
	num1, num2 := 1, 2
	var result int

	retry1 := retry.NewPeriodicIntervalRetry(1, time.Second)
	err := retry1.Run(context.TODO(), func(ctx context.Context) (success bool, err error) {
		result = num1 + num2
		return true, nil
	})
	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Printf("%d + %d = %v\n", num1, num2, result)
	}

	// Output:
	// 1 + 2 = 3
}

Documentation

Overview

Package retry provides some retry policies to call a function.

Index

• type Retry
  • func NewPeriodicIntervalRetry(number int, interval time.Duration) Retry

Types

type Retry

type Retry interface {
	// If f returns true or nil, it terminates retry.
	Run(c context.Context, f func(context.Context) (success bool, err error)) error
}

Retry is an interface to retry the function until a condition reaches.

func NewPeriodicIntervalRetry

func NewPeriodicIntervalRetry(number int, interval time.Duration) Retry

NewPeriodicIntervalRetry returns a new retry to call a runner function periodically until the context is done or it reaches the number.

number is the times to recall a function, which should be positive. If 0 or negative, it does nothing.

interval is the interval duration between two callings. If 0, it immediately retries to call.