httpclient

Documentation

Index

• func NewClient(options ...ClientOption) *http.Client
• func NewClientWithTransport(transport http.RoundTripper) *http.Client
• type ClientInterceptorFunc
• type ClientOption
  • func WithH2C() ClientOption
  • func WithInterceptorFunc(interceptorFunc ClientInterceptorFunc) ClientOption
  • func WithObservability(tags ...tag.Mutator) ClientOption
  • func WithProxy(proxyFunc Proxy) ClientOption
  • func WithTLSConfig(tlsConfig *tls.Config) ClientOption
• type Proxy

Functions

func NewClient

func NewClient(options ...ClientOption) *http.Client

NewClient returns a new Client.

func NewClientWithTransport

func NewClientWithTransport(transport http.RoundTripper) *http.Client

NewClientWithTransport returns a new Client with the given transport. This is a separate constructor so that it's clear it cannot be used in combination with other ClientOptions.

Types

type ClientInterceptorFunc

type ClientInterceptorFunc func(http.RoundTripper) http.RoundTripper

ClientInterceptorFunc is a function that wraps a RoundTripper with any interceptors

type ClientOption

type ClientOption func(*clientOptions)

ClientOption is an option for a new Client.

func WithH2C

func WithH2C() ClientOption

WithH2C returns a new ClientOption that allows dialing h2c (cleartext) servers.

func WithInterceptorFunc

func WithInterceptorFunc(interceptorFunc ClientInterceptorFunc) ClientOption

WithInterceptorFunc returns a new ClientOption to use a given interceptor.

func WithObservability

func WithObservability(tags ...tag.Mutator) ClientOption

WithObservability returns a new ClientOption to use OpenCensus tracing and metrics.

The default is to use no observability.

func WithProxy

func WithProxy(proxyFunc Proxy) ClientOption

WithProxy returns a new ClientOption to use a proxy.

The default is to use http.ProxyFromEnvironment

func WithTLSConfig

func WithTLSConfig(tlsConfig *tls.Config) ClientOption

WithTLSConfig returns a new ClientOption to use the tls.Config.

The default is to use no TLS.

type Proxy

type Proxy func(req *http.Request) (*url.URL, error)

Proxy specifies a function to return a proxy for a given Request. If the function returns a non-nil error, the request is aborted with the provided error.