httpr

Documentation

Index

• type Backoff
• type Client
  • func NewClient(options ...Option) *Client
  • func (c Client) Do(r *http.Request) (*http.Response, error)
• type Option
  • func WithRetryPolicy(retryPolicy RetryPolicy) Option
  • func WithTimeout(d time.Duration) Option
  • func WithTransport(transport *http.Transport) Option
• type Retry
• type RetryPolicy
  • func (r RetryPolicy) IsZero() bool

Types

type Backoff

type Backoff func(delay, maxDelay time.Duration, retry int) time.Duration

Backoff provides delays between retries with backoff.

type Client

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

Client wraps around a standard library *http.Client with added retry functionality.

func NewClient

func NewClient(options ...Option) *Client

NewClient creates and returns a new *Client with the provided options.

func (Client) Do

func (c Client) Do(r *http.Request) (*http.Response, error)

Do sends an HTTP request and returns an HTTP response.

type Option

type Option func(c *Client)

Option is a function that configures a *Client.

func WithRetryPolicy

func WithRetryPolicy(retryPolicy RetryPolicy) Option

WithRetryPolicy sets retry policy for the *Client.

func WithTimeout

func WithTimeout(d time.Duration) Option

WithTimeout sets the timeout of the *Client.

func WithTransport

func WithTransport(transport *http.Transport) Option

WithTransport sets the transport for the *Client.

type Retry

type Retry func(r *http.Response, err error) bool

Retry is a function that takes an *http.Response and an error and evaluates if a retry should be done.

type RetryPolicy

type RetryPolicy struct {
	Retry      Retry
	Backoff    Backoff
	MinDelay   time.Duration
	MaxDelay   time.Duration
	MaxRetries int
}

RetryPolicy contains rules for retries.

func (RetryPolicy) IsZero

func (r RetryPolicy) IsZero() bool

IsZero returns true if the RetryPolicy is the zero value.