retry

Documentation

Index

• Constants
• func IsRetryableDefault(err error) bool
• func IsRetryableNoOp(err error) bool
• type Config
• type Retry
  • func New() *Retry
  • func (r *Retry) Do(req *http.Request, do func(*http.Request) (*http.Response, error)) (*http.Response, error)
  • func (c *Retry) SetIsRetryable(f ...func(err error) bool) *Retry
  • func (c *Retry) SetMaxRetries(r int) *Retry
  • func (c *Retry) SetThrottle(d time.Duration) *Retry
  • func (c *Retry) SetTimeout(d time.Duration) *Retry
  • func (c *Retry) SetUntil(f ...UntilFn) *Retry
• type UntilFn

Constants

const (
	// timeout configuration constants
	CONFIG_IS_RETRYABLE = "IsRetryable"

	// requesrt errors
	ERR_NO_SUCH_HOST = "dial tcp: lookup"
)

const (
	// timeout configuration constants
	CONFIG_THROTTLE         = "Throttle"
	CONFIG_THROTTLE_DEFAULT = 1 * time.Second
)

const (
	// timeout configuration constants
	CONFIG_TIMEOUT         = "Timeout"
	CONFIG_TIMEOUT_DEFAULT = 2 * time.Minute
)

const (
	// name of the configuration
	CONFIG_MAX_RETRIES = "MaxRetries"
)

const (
	// Wait configuration constants
	CONFIG_UNTIL = "Until"
)

Functions

func IsRetryableDefault

func IsRetryableDefault(err error) bool

IsRetryableDefault

func IsRetryableNoOp

func IsRetryableNoOp(err error) bool

IsRetryableNoOp always retries

Types

type Config

type Config interface {
	String() string
	Value() interface{}
}

type Retry

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

func New

func New() *Retry

New returns a new instance of Retry with default values

func (*Retry) Do

func (r *Retry) Do(req *http.Request, do func(*http.Request) (*http.Response, error)) (*http.Response, error)

Do runs a given do function with a given request -> do(req)

func (*Retry) SetIsRetryable

func (c *Retry) SetIsRetryable(f ...func(err error) bool) *Retry

SetIsRetryable sets functions that determin if an error can be retried or not

func (*Retry) SetMaxRetries

func (c *Retry) SetMaxRetries(r int) *Retry

SetMaxRetries sets the maximum retries

func (*Retry) SetThrottle

func (c *Retry) SetThrottle(d time.Duration) *Retry

SetThrottle sets the duration to wait between calls

func (*Retry) SetTimeout

func (c *Retry) SetTimeout(d time.Duration) *Retry

SetTimeout sets the maximum run duration

func (*Retry) SetUntil

func (c *Retry) SetUntil(f ...UntilFn) *Retry

SetUntil sets functions that determin if the response given is the expected response this functionality is useful, for example, when waiting for an API status to be ready

type UntilFn

type UntilFn func(*http.Response) (bool, error)