httputils

Documentation

Index

• type HttpClientDetails
  • func (hcd *HttpClientDetails) AddHeader(headerName, headerValue string)
  • func (hcd *HttpClientDetails) AddPreRetryInterceptor(preRetryInterceptors PreRetryInterceptor)
  • func (hcd HttpClientDetails) Clone() *HttpClientDetails
  • func (hcd *HttpClientDetails) SetContentTypeApplicationJson()
• type PollingAction
• type PollingExecutor
  • func (runner *PollingExecutor) Execute() ([]byte, error)
• type PreRetryInterceptor

Types

type HttpClientDetails

type HttpClientDetails struct {
	User                  string
	Password              string
	ApiKey                string
	AccessToken           string
	Headers               map[string]string
	Transport             *http.Transport
	DialTimeout           time.Duration
	OverallRequestTimeout time.Duration
	// Prior to each retry attempt, the list of PreRetryInterceptors is invoked sequentially. If any of these interceptors yields a 'false' response, the retry process stops instantly.
	PreRetryInterceptors []PreRetryInterceptor
}

func (*HttpClientDetails) AddHeader

func (hcd *HttpClientDetails) AddHeader(headerName, headerValue string)

func (*HttpClientDetails) AddPreRetryInterceptor

func (hcd *HttpClientDetails) AddPreRetryInterceptor(preRetryInterceptors PreRetryInterceptor)

func (HttpClientDetails) Clone

func (hcd HttpClientDetails) Clone() *HttpClientDetails

func (*HttpClientDetails) SetContentTypeApplicationJson

func (hcd *HttpClientDetails) SetContentTypeApplicationJson()

type PollingAction

type PollingAction func() (shouldStop bool, responseBody []byte, err error)

type PollingExecutor

type PollingExecutor struct {
	// Maximum wait time in nanoseconds.
	Timeout time.Duration
	// Number of nanoseconds to sleep between polling attempts.
	PollingInterval time.Duration
	// Prefix to add at the beginning of each info/error message.
	MsgPrefix string
	// pollingAction is the operation to run until the condition fulfilled.
	PollingAction PollingAction
}

func (*PollingExecutor) Execute

func (runner *PollingExecutor) Execute() ([]byte, error)

type PreRetryInterceptor

type PreRetryInterceptor func() (shouldRetry bool)