zhttp

Documentation

Index

• Constants
• Variables
• func HeaderMap(h http.Header) map[string]string
• func IsHTTPStatusRetryable(httpStatusCode int) (ok bool)
• func IsHTTPSuccessStatus(httpStatusCode int) (ok bool)
• func NewRetryTimer(ctx context.Context, opts ...func(option *RetryOption)) <-chan int
• func ParseProxy(proxy string) (*url.URL, error)
• func Transport(secure bool, proxy func(*http.Request) (*url.URL, error)) *http.Transport
• type DefaultRequest
  • func (*DefaultRequest) ContextDo(ctx context.Context, r *http.Request) (*http.Response, error)
  • func (*DefaultRequest) Do(r *http.Request) (*http.Response, error)
• type Request
  • func NewRequest(opts ...RequestOption) Request
• type RequestOption
• type ResponseParse
• type Retry
  • func WithJitter(jitter float64) Retry
  • func WithMaxRetry(maxRetry int) Retry
  • func WithRandom(random *rand.Rand) Retry
  • func WithRetryCap(retryCap time.Duration) Retry
  • func WithRetryUnit(retryUnit time.Duration) Retry
• type RetryOption

Constants

const (
	MaxJitter = 1.0
	NoJitter  = 0.0
)

Variables

var (
	MaxRetry  = 3
	RetryUnit = 100 * time.Millisecond
	RetryCap  = time.Second
	Random    = rand.New(rand.NewSource(time.Now().UTC().UnixNano()))
)

var DefaultClient = &http.Client{
	Transport: Transport(false, nil),
}

var (
	DefaultRespParse = &defaultParse{}
)

var RetryableHTTPStatusCodes = map[int]struct{}{
	http.StatusTooManyRequests:     {},
	http.StatusInternalServerError: {},
	http.StatusBadGateway:          {},
	http.StatusServiceUnavailable:  {},
	http.StatusGatewayTimeout:      {},
}

var SuccessStatusCodes = map[int]struct{}{
	http.StatusOK:             {},
	http.StatusNoContent:      {},
	http.StatusPartialContent: {},
}

Functions

func HeaderMap

func HeaderMap(h http.Header) map[string]string

func IsHTTPStatusRetryable

func IsHTTPStatusRetryable(httpStatusCode int) (ok bool)

func IsHTTPSuccessStatus

func IsHTTPSuccessStatus(httpStatusCode int) (ok bool)

func NewRetryTimer

func NewRetryTimer(ctx context.Context, opts ...func(option *RetryOption)) <-chan int

func ParseProxy

func ParseProxy(proxy string) (*url.URL, error)

func Transport

func Transport(secure bool, proxy func(*http.Request) (*url.URL, error)) *http.Transport

Types

type DefaultRequest

type DefaultRequest struct{}

func (*DefaultRequest) ContextDo

func (*DefaultRequest) ContextDo(ctx context.Context, r *http.Request) (*http.Response, error)

func (*DefaultRequest) Do

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

type Request

type Request interface {
	Do(*http.Request) (*http.Response, error)
	ContextDo(context.Context, *http.Request) (*http.Response, error)
}

func NewRequest

func NewRequest(opts ...RequestOption) Request

type RequestOption

type RequestOption func(r *DefaultRequest)

type ResponseParse

type ResponseParse interface {
	Parse(*http.Response, any) error
	ParseHeader(*http.Response, any) error
	ParseBody(*http.Response, any) error
}

type Retry

type Retry func(option *RetryOption)

func WithJitter

func WithJitter(jitter float64) Retry

func WithMaxRetry

func WithMaxRetry(maxRetry int) Retry

func WithRandom

func WithRandom(random *rand.Rand) Retry

func WithRetryCap

func WithRetryCap(retryCap time.Duration) Retry

func WithRetryUnit

func WithRetryUnit(retryUnit time.Duration) Retry

type RetryOption

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