config

Documentation

Index

• Constants
• type DialContext
• type HttpConfig
  • func DefaultHttpConfig() *HttpConfig
  • func (config *HttpConfig) WithAllowRedirects(allowRedirects bool) *HttpConfig
  • func (config *HttpConfig) WithDialContext(dial DialContext) *HttpConfig
  • func (config *HttpConfig) WithHttpHandler(handler *httphandler.HttpHandler) *HttpConfig
  • func (config *HttpConfig) WithHttpTransport(transport *http.Transport) *HttpConfig
  • func (config *HttpConfig) WithIgnoreContentTypeForGetRequest(ignoreContentTypeForGetRequest bool) *HttpConfig
  • func (config *HttpConfig) WithIgnoreSSLVerification(ignore bool) *HttpConfig
  • func (config *HttpConfig) WithProxy(proxy *Proxy) *HttpConfig
  • func (config *HttpConfig) WithRetries(retries int) *HttpConfig
  • func (config *HttpConfig) WithSigningAlgorithm(signingAlgorithm algorithm.SigningAlgorithm) *HttpConfig
  • func (config *HttpConfig) WithTimeout(timeout time.Duration) *HttpConfig
• type Proxy
  • func NewProxy() *Proxy
  • func (p *Proxy) GetProxyUrl() string
  • func (p *Proxy) WithHost(host string) *Proxy
  • func (p *Proxy) WithPassword(pwd string) *Proxy
  • func (p *Proxy) WithPort(port int) *Proxy
  • func (p *Proxy) WithSchema(schema string) *Proxy
  • func (p *Proxy) WithUsername(name string) *Proxy

Constants

const (
	DefaultTimeout                        = 120 * time.Second
	DefaultRetries                        = 0
	DefaultIgnoreSSLVerification          = false
	DefaultIgnoreContentTypeForGetRequest = false
)

Types

type DialContext

type DialContext func(ctx context.Context, network string, addr string) (net.Conn, error)

type HttpConfig

type HttpConfig struct {
	DialContext           DialContext
	Timeout               time.Duration
	Retries               int
	HttpProxy             *Proxy
	IgnoreSSLVerification bool
	// AllowRedirects Experimental configuration, the default value is false.
	// Automatic redirection is allowed when turns on, which may cause some request exceptions.
	AllowRedirects bool
	HttpHandler    *httphandler.HttpHandler
	// HttpTransport This configuration has the highest priority,
	// which means specifying the HttpTransport will invalidate other configurations,
	// such as DialContext, HttpProxy, IgnoreSSLVerification.
	HttpTransport *http.Transport
	// IgnoreContentTypeForGetRequest Ignore the request header Content-Type when sending a GET request,
	// the default value is false
	IgnoreContentTypeForGetRequest bool
	SigningAlgorithm               algorithm.SigningAlgorithm
}

func DefaultHttpConfig

func DefaultHttpConfig() *HttpConfig

func (*HttpConfig) WithAllowRedirects

func (config *HttpConfig) WithAllowRedirects(allowRedirects bool) *HttpConfig

WithAllowRedirects Experimental configuration, the default value is false. Automatic redirection is allowed when turns on, which may cause some request exceptions.

func (*HttpConfig) WithDialContext

func (config *HttpConfig) WithDialContext(dial DialContext) *HttpConfig

func (*HttpConfig) WithHttpHandler

func (config *HttpConfig) WithHttpHandler(handler *httphandler.HttpHandler) *HttpConfig

func (*HttpConfig) WithHttpTransport

func (config *HttpConfig) WithHttpTransport(transport *http.Transport) *HttpConfig

WithHttpTransport This configuration has the highest priority, which means specifying the HttpTransport will invalidate other configurations, such as DialContext, HttpProxy, IgnoreSSLVerification.

func (*HttpConfig) WithIgnoreContentTypeForGetRequest

func (config *HttpConfig) WithIgnoreContentTypeForGetRequest(ignoreContentTypeForGetRequest bool) *HttpConfig

WithIgnoreContentTypeForGetRequest Ignore the request header Content-Type when sending a GET request, the default value is false

func (*HttpConfig) WithIgnoreSSLVerification

func (config *HttpConfig) WithIgnoreSSLVerification(ignore bool) *HttpConfig

func (*HttpConfig) WithProxy

func (config *HttpConfig) WithProxy(proxy *Proxy) *HttpConfig

func (*HttpConfig) WithRetries

func (config *HttpConfig) WithRetries(retries int) *HttpConfig

func (*HttpConfig) WithSigningAlgorithm

func (config *HttpConfig) WithSigningAlgorithm(signingAlgorithm algorithm.SigningAlgorithm) *HttpConfig

func (*HttpConfig) WithTimeout

func (config *HttpConfig) WithTimeout(timeout time.Duration) *HttpConfig

type Proxy

type Proxy struct {
	Schema   string
	Host     string
	Port     int
	Username string
	Password string
}

func NewProxy

func NewProxy() *Proxy

func (*Proxy) GetProxyUrl

func (p *Proxy) GetProxyUrl() string

func (*Proxy) WithHost

func (p *Proxy) WithHost(host string) *Proxy

func (*Proxy) WithPassword

func (p *Proxy) WithPassword(pwd string) *Proxy

func (*Proxy) WithPort

func (p *Proxy) WithPort(port int) *Proxy

func (*Proxy) WithSchema

func (p *Proxy) WithSchema(schema string) *Proxy

func (*Proxy) WithUsername

func (p *Proxy) WithUsername(name string) *Proxy