README
¶
Package retry v1.4.1
This library implements a retryer: a generic way to execute some code at regular interval.
Usage
Creating a new retryer is done with:
retry.New(retry.WithWaitDuration(10*time.Second), retry.WithMaxAttempts(5))
Possible options for the constructor are:
WithWaitDuration: time interval between each execution of the code (default to 10 seconds).WithMaxDuration: the retryer will stop executing after the specified amount of time (disabled by default).WithMaxAttempts: the retryer will execute the at most N times. N being this max attempts parameter (default to 5).WithoutMaxAttempts: disable the max attempts parameter.
Then execute the retryer with:
err = retryer.Do(ctx, func(ctx context.Context) error {
// ...
})
The function given as parameter only returns an error. If this error has the
type RetryCancelError, it stops the execution of the retryer. You can
create such error with NewRetryCancelError.
Documentation
¶
Index ¶
- type ErrorCallback
- type Retry
- type RetryCancelError
- type RetryError
- type RetryErrorScope
- type Retryable
- type Retryer
- type RetryerOptsFunc
- func WithErrorCallback(c ErrorCallback) RetryerOptsFunc
- func WithExponentialBackoff(factor uint) RetryerOptsFunc
- func WithLoggingOnAttemptError(severity logrus.Level) RetryerOptsFunc
- func WithMaxAttempts(maxAttempts int) RetryerOptsFunc
- func WithMaxDuration(duration time.Duration) RetryerOptsFunc
- func WithWaitDuration(duration time.Duration) RetryerOptsFunc
- func WithoutMaxAttempts() RetryerOptsFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorCallback ¶
type RetryCancelError ¶
type RetryCancelError struct {
// contains filtered or unexported fields
}
RetryCancelError is a error wrapping type that the user of a Retry should use to cancel retry operations before the end of maxAttempts/maxDuration conditions
func NewRetryCancelError ¶
func NewRetryCancelError(err error) RetryCancelError
func (RetryCancelError) Error ¶
func (err RetryCancelError) Error() string
func (RetryCancelError) Unwrap ¶ added in v1.3.0
func (err RetryCancelError) Unwrap() error
type RetryError ¶
type RetryError struct {
Scope RetryErrorScope
Err error
LastErr error
}
func (RetryError) Error ¶
func (err RetryError) Error() string
func (RetryError) Unwrap ¶ added in v1.3.0
func (err RetryError) Unwrap() error
type RetryErrorScope ¶
type RetryErrorScope string
const ( MaxDurationScope RetryErrorScope = "max-duration" ContextScope RetryErrorScope = "context" )
type Retryer ¶
type Retryer struct {
// contains filtered or unexported fields
}
func New ¶
func New(opts ...RetryerOptsFunc) Retryer
type RetryerOptsFunc ¶
type RetryerOptsFunc func(r *Retryer)
func WithErrorCallback ¶
func WithErrorCallback(c ErrorCallback) RetryerOptsFunc
func WithExponentialBackoff ¶ added in v1.4.0
func WithExponentialBackoff(factor uint) RetryerOptsFunc
WithExponentialBackoff enables the exponential backoff wait duration. When enabled, the delay between each attempt is the wait duration multiplied by the given factor. For example, with a wait duration of 100ms and a factor of 2: Attempt 1: Wait 100 milliseconds (100 * 2^0) Attempt 2: Wait 200 milliseconds (100 * 2^1) Attempt 3: Wait 400 milliseconds (100 * 2^2) Attempt 4: Wait 800 milliseconds (100 * 2^3)
func WithLoggingOnAttemptError ¶ added in v1.2.2
func WithLoggingOnAttemptError(severity logrus.Level) RetryerOptsFunc
WithLoggingOnAttemptError allows emitting a log message on each attempt which failed. The capacity to specify the severity of the log message is useful to avoid flooding the logs with too many messages in case of a retry loop. Most of the time it will be Debug or Info according to the type of operation. Error should be chosen carefully if logger was configured to send Errors to a tool like Rollbar/Sentry/...
func WithMaxAttempts ¶
func WithMaxAttempts(maxAttempts int) RetryerOptsFunc
func WithMaxDuration ¶
func WithMaxDuration(duration time.Duration) RetryerOptsFunc
func WithWaitDuration ¶
func WithWaitDuration(duration time.Duration) RetryerOptsFunc
func WithoutMaxAttempts ¶
func WithoutMaxAttempts() RetryerOptsFunc
Source Files