retry

Documentation

Overview

Package retry contains utilities for performing retries when functions return errors.

Index

• func Do(ctx context.Context, max int, fn func(ctx context.Context) error) error
• func Stop(err error) error

Functions

func Do

func Do(ctx context.Context, max int, fn func(ctx context.Context) error) error

Do performs an action with a maximum number of retries. If fn returns a non-nil error, it will be retried up to the maximum number of times and then returned. If fn returns a nil error, the retry loop is broken. The loop is also broken if the provided context is cancelled. Returning an error wrapped with the Stop function will prevent further retries from occurring.

func Stop

func Stop(err error) error

Stop wraps err so that when it is returned to the retry mechanism no further retries are attempted.