httpclient

Jan 13, 2025

Changes in this version

type ClientOrHTTPClientParam

+ func WithInnerMiddleware(h Middleware) ClientOrHTTPClientParam

Nov 27, 2024

Changes in this version

type RequestParam

+ func WithRequestConjureErrorDecoder(ced errors.ConjureErrorDecoder) RequestParam

Nov 21, 2024

Changes in this version

+ func RetrieveReaderFromRequestBody(body RequestBody) (io.ReadCloser, int64, error)

Nov 19, 2024

Changes in this version

+ type RequestBody interface

+ func RequestBodyEmpty() RequestBody

+ func RequestBodyEncoderObject(input any, encoder codecs.Encoder) RequestBody

+ func RequestBodyEncoderObjectBuffer(input any, encoder codecs.Encoder, buffer *bytes.Buffer) RequestBody

+ func RequestBodyInMemory[T bytes.Buffer | bytes.Reader | strings.Reader](input *T) RequestBody

+ func RequestBodyStreamOnce[T requestBodyStreamInput](input T) RequestBody

+ func RequestBodyStreamWithReplay[T requestBodyStreamInput](input T) RequestBody

type RequestParam

+ func WithBinaryRequestBody(input RequestBody) RequestParam

Sep 27, 2024

Changes in this version

+ var ErrEmptyURIs = fmt.Errorf("httpclient URLs must not be empty")

type ClientConfig

+ KeepAlive *time.Duration

+ ResponseHeaderTimeout *time.Duration

type ClientParam

+ func WithAllowCreateWithEmptyURIs() ClientParam

type RefreshableClientConfig

+ KeepAlive func() refreshable.DurationPtr

+ ResponseHeaderTimeout func() refreshable.DurationPtr

type RefreshableSecurityConfig

+ InsecureSkipVerify func() refreshable.BoolPtr

type RefreshingClientConfig

+ func (r RefreshingClientConfig) KeepAlive() refreshable.DurationPtr

+ func (r RefreshingClientConfig) ResponseHeaderTimeout() refreshable.DurationPtr

type RefreshingSecurityConfig

+ func (r RefreshingSecurityConfig) InsecureSkipVerify() refreshable.BoolPtr

type SecurityConfig

+ InsecureSkipVerify *bool

Sep 20, 2024

Changes in this version

+ type BasicAuthOptionalProvider func(context.Context) (*BasicAuth, error)

type ClientOrHTTPClientParam

+ func WithBasicAuthOptionalProvider(provider BasicAuthOptionalProvider) ClientOrHTTPClientParam

Mar 15, 2024

Changes in this version

type ClientParam

+ func WithBasicAuthProvider(provider BasicAuthProvider) ClientParam

Nov 28, 2023

Changes in this version

type RequestParam

+ func WithRequestTimeout(timeout time.Duration) RequestParam

Sep 18, 2023

Changes in this version

type ClientParam

+ func WithRefreshableBaseURLs(urls refreshable.StringSlice) ClientParam

Jun 15, 2023

Changes in this version

type ClientOrHTTPClientParam

+ func WithOverrideRequestHost(host string) ClientOrHTTPClientParam

Dec 9, 2022

Changes in this version

+ type BasicAuth struct

+ Password string

+ User string

+ type BasicAuthProvider func(context.Context) (BasicAuth, error)

type ClientConfig

+ BasicAuth *BasicAuth

+ type RefreshableBasicAuth interface

+ CurrentBasicAuth func() BasicAuth

+ MapBasicAuth func(func(BasicAuth) interface{}) refreshable.Refreshable

+ Password func() refreshable.String

+ SubscribeToBasicAuth func(func(BasicAuth)) (unsubscribe func())

+ User func() refreshable.String

+ type RefreshableBasicAuthPtr interface

+ CurrentBasicAuthPtr func() *BasicAuth

+ MapBasicAuthPtr func(func(*BasicAuth) interface{}) refreshable.Refreshable

+ Password func() refreshable.String

+ SubscribeToBasicAuthPtr func(func(*BasicAuth)) (unsubscribe func())

+ User func() refreshable.String

type RefreshableClientConfig

+ BasicAuth func() RefreshableBasicAuthPtr

+ type RefreshingBasicAuth struct

+ func NewRefreshingBasicAuth(in refreshable.Refreshable) RefreshingBasicAuth

+ func (r RefreshingBasicAuth) CurrentBasicAuth() BasicAuth

+ func (r RefreshingBasicAuth) MapBasicAuth(mapFn func(BasicAuth) interface{}) refreshable.Refreshable

+ func (r RefreshingBasicAuth) Password() refreshable.String

+ func (r RefreshingBasicAuth) SubscribeToBasicAuth(consumer func(BasicAuth)) (unsubscribe func())

+ func (r RefreshingBasicAuth) User() refreshable.String

+ type RefreshingBasicAuthPtr struct

+ func NewRefreshingBasicAuthPtr(in refreshable.Refreshable) RefreshingBasicAuthPtr

+ func (r RefreshingBasicAuthPtr) CurrentBasicAuthPtr() *BasicAuth

+ func (r RefreshingBasicAuthPtr) MapBasicAuthPtr(mapFn func(*BasicAuth) interface{}) refreshable.Refreshable

+ func (r RefreshingBasicAuthPtr) Password() refreshable.String

+ func (r RefreshingBasicAuthPtr) SubscribeToBasicAuthPtr(consumer func(*BasicAuth)) (unsubscribe func())

+ func (r RefreshingBasicAuthPtr) User() refreshable.String

type RefreshingClientConfig

+ func (r RefreshingClientConfig) BasicAuth() RefreshableBasicAuthPtr

Dec 1, 2022

Changes in this version

type RequestParam

+ func WithSnappyCompressedRequest(input interface{}, codec codecs.Codec) RequestParam

Aug 18, 2022

Changes in this version

type ClientParam

+ func WithRandomURIScoring() ClientParam

Oct 8, 2021

Changes in this version

type Client

+ func NewClientFromRefreshableConfig(ctx context.Context, config RefreshableClientConfig, params ...ClientParam) (Client, error)

+ type RefreshableClientConfig interface

+ APIToken func() refreshable.StringPtr

+ APITokenFile func() refreshable.StringPtr

+ ConnectTimeout func() refreshable.DurationPtr

+ CurrentClientConfig func() ClientConfig

+ DisableHTTP2 func() refreshable.BoolPtr

+ ExpectContinueTimeout func() refreshable.DurationPtr

+ HTTP2PingTimeout func() refreshable.DurationPtr

+ HTTP2ReadIdleTimeout func() refreshable.DurationPtr

+ IdleConnTimeout func() refreshable.DurationPtr

+ InitialBackoff func() refreshable.DurationPtr

+ MapClientConfig func(func(ClientConfig) interface{}) refreshable.Refreshable

+ MaxBackoff func() refreshable.DurationPtr

+ MaxIdleConns func() refreshable.IntPtr

+ MaxIdleConnsPerHost func() refreshable.IntPtr

+ MaxNumRetries func() refreshable.IntPtr

+ Metrics func() RefreshableMetricsConfig

+ ProxyFromEnvironment func() refreshable.BoolPtr

+ ProxyURL func() refreshable.StringPtr

+ ReadTimeout func() refreshable.DurationPtr

+ Security func() RefreshableSecurityConfig

+ ServiceName func() refreshable.String

+ SubscribeToClientConfig func(func(ClientConfig)) (unsubscribe func())

+ TLSHandshakeTimeout func() refreshable.DurationPtr

+ URIs func() refreshable.StringSlice

+ WriteTimeout func() refreshable.DurationPtr

+ func RefreshableClientConfigFromServiceConfig(servicesConfig RefreshableServicesConfig, serviceName string) RefreshableClientConfig

+ type RefreshableHTTPClient = refreshingclient.RefreshableHTTPClient

+ func NewHTTPClientFromRefreshableConfig(ctx context.Context, config RefreshableClientConfig, params ...HTTPClientParam) (RefreshableHTTPClient, error)

+ type RefreshableMetricsConfig interface

+ CurrentMetricsConfig func() MetricsConfig

+ Enabled func() refreshable.BoolPtr

+ MapMetricsConfig func(func(MetricsConfig) interface{}) refreshable.Refreshable

+ SubscribeToMetricsConfig func(func(MetricsConfig)) (unsubscribe func())

+ Tags func() RefreshableStringToString

+ type RefreshableSecurityConfig interface

+ CAFiles func() refreshable.StringSlice

+ CertFile func() refreshable.String

+ CurrentSecurityConfig func() SecurityConfig

+ KeyFile func() refreshable.String

+ MapSecurityConfig func(func(SecurityConfig) interface{}) refreshable.Refreshable

+ SubscribeToSecurityConfig func(func(SecurityConfig)) (unsubscribe func())

+ type RefreshableServicesConfig interface

+ CurrentServicesConfig func() ServicesConfig

+ Default func() RefreshableClientConfig

+ MapServicesConfig func(func(ServicesConfig) interface{}) refreshable.Refreshable

+ Services func() RefreshableStringToClientConfig

+ SubscribeToServicesConfig func(func(ServicesConfig)) (unsubscribe func())

+ type RefreshableStringToClientConfig interface

+ CurrentStringToClientConfig func() map[string]ClientConfig

+ MapStringToClientConfig func(func(map[string]ClientConfig) interface{}) refreshable.Refreshable

+ SubscribeToStringToClientConfig func(func(map[string]ClientConfig)) (unsubscribe func())

+ type RefreshableStringToString interface

+ CurrentStringToString func() map[string]string

+ MapStringToString func(func(map[string]string) interface{}) refreshable.Refreshable

+ SubscribeToStringToString func(func(map[string]string)) (unsubscribe func())

+ type RefreshingClientConfig struct

+ func NewRefreshingClientConfig(in refreshable.Refreshable) RefreshingClientConfig

+ func (r RefreshingClientConfig) APIToken() refreshable.StringPtr

+ func (r RefreshingClientConfig) APITokenFile() refreshable.StringPtr

+ func (r RefreshingClientConfig) ConnectTimeout() refreshable.DurationPtr

+ func (r RefreshingClientConfig) CurrentClientConfig() ClientConfig

+ func (r RefreshingClientConfig) DisableHTTP2() refreshable.BoolPtr

+ func (r RefreshingClientConfig) ExpectContinueTimeout() refreshable.DurationPtr

+ func (r RefreshingClientConfig) HTTP2PingTimeout() refreshable.DurationPtr

+ func (r RefreshingClientConfig) HTTP2ReadIdleTimeout() refreshable.DurationPtr

+ func (r RefreshingClientConfig) IdleConnTimeout() refreshable.DurationPtr

+ func (r RefreshingClientConfig) InitialBackoff() refreshable.DurationPtr

+ func (r RefreshingClientConfig) MapClientConfig(mapFn func(ClientConfig) interface{}) refreshable.Refreshable

+ func (r RefreshingClientConfig) MaxBackoff() refreshable.DurationPtr

+ func (r RefreshingClientConfig) MaxIdleConns() refreshable.IntPtr

+ func (r RefreshingClientConfig) MaxIdleConnsPerHost() refreshable.IntPtr

+ func (r RefreshingClientConfig) MaxNumRetries() refreshable.IntPtr

+ func (r RefreshingClientConfig) Metrics() RefreshableMetricsConfig

+ func (r RefreshingClientConfig) ProxyFromEnvironment() refreshable.BoolPtr

+ func (r RefreshingClientConfig) ProxyURL() refreshable.StringPtr

+ func (r RefreshingClientConfig) ReadTimeout() refreshable.DurationPtr

+ func (r RefreshingClientConfig) Security() RefreshableSecurityConfig

+ func (r RefreshingClientConfig) ServiceName() refreshable.String

+ func (r RefreshingClientConfig) SubscribeToClientConfig(consumer func(ClientConfig)) (unsubscribe func())

+ func (r RefreshingClientConfig) TLSHandshakeTimeout() refreshable.DurationPtr

+ func (r RefreshingClientConfig) URIs() refreshable.StringSlice

+ func (r RefreshingClientConfig) WriteTimeout() refreshable.DurationPtr

+ type RefreshingMetricsConfig struct

+ func NewRefreshingMetricsConfig(in refreshable.Refreshable) RefreshingMetricsConfig

+ func (r RefreshingMetricsConfig) CurrentMetricsConfig() MetricsConfig

+ func (r RefreshingMetricsConfig) Enabled() refreshable.BoolPtr

+ func (r RefreshingMetricsConfig) MapMetricsConfig(mapFn func(MetricsConfig) interface{}) refreshable.Refreshable

+ func (r RefreshingMetricsConfig) SubscribeToMetricsConfig(consumer func(MetricsConfig)) (unsubscribe func())

+ func (r RefreshingMetricsConfig) Tags() RefreshableStringToString

+ type RefreshingSecurityConfig struct

+ func NewRefreshingSecurityConfig(in refreshable.Refreshable) RefreshingSecurityConfig

+ func (r RefreshingSecurityConfig) CAFiles() refreshable.StringSlice

+ func (r RefreshingSecurityConfig) CertFile() refreshable.String

+ func (r RefreshingSecurityConfig) CurrentSecurityConfig() SecurityConfig

+ func (r RefreshingSecurityConfig) KeyFile() refreshable.String

+ func (r RefreshingSecurityConfig) MapSecurityConfig(mapFn func(SecurityConfig) interface{}) refreshable.Refreshable

+ func (r RefreshingSecurityConfig) SubscribeToSecurityConfig(consumer func(SecurityConfig)) (unsubscribe func())

+ type RefreshingServicesConfig struct

+ func NewRefreshingServicesConfig(in refreshable.Refreshable) RefreshingServicesConfig

+ func (r RefreshingServicesConfig) CurrentServicesConfig() ServicesConfig

+ func (r RefreshingServicesConfig) Default() RefreshableClientConfig

+ func (r RefreshingServicesConfig) MapServicesConfig(mapFn func(ServicesConfig) interface{}) refreshable.Refreshable

+ func (r RefreshingServicesConfig) Services() RefreshableStringToClientConfig

+ func (r RefreshingServicesConfig) SubscribeToServicesConfig(consumer func(ServicesConfig)) (unsubscribe func())

+ type RefreshingStringToClientConfig struct

+ func NewRefreshingStringToClientConfig(in refreshable.Refreshable) RefreshingStringToClientConfig

+ func (r RefreshingStringToClientConfig) CurrentStringToClientConfig() map[string]ClientConfig

+ func (r RefreshingStringToClientConfig) MapStringToClientConfig(mapFn func(map[string]ClientConfig) interface{}) refreshable.Refreshable

+ func (r RefreshingStringToClientConfig) SubscribeToStringToClientConfig(consumer func(map[string]ClientConfig)) (unsubscribe func())

+ type RefreshingStringToString struct

+ func NewRefreshingStringToString(in refreshable.Refreshable) RefreshingStringToString

+ func (r RefreshingStringToString) CurrentStringToString() map[string]string

+ func (r RefreshingStringToString) MapStringToString(mapFn func(map[string]string) interface{}) refreshable.Refreshable

+ func (r RefreshingStringToString) SubscribeToStringToString(consumer func(map[string]string)) (unsubscribe func())

Sep 28, 2021

Changes in this version

type ClientConfig

+ func MergeClientConfig(conf, defaults ClientConfig) ClientConfig

type ClientParam

+ func WithBalancedURIScoring() ClientParam

Jun 21, 2021

Changes in this version

type ClientConfig

+ HTTP2PingTimeout *time.Duration

+ HTTP2ReadIdleTimeout *time.Duration

type ClientOrHTTPClientParam

+ func WithHTTP2PingTimeout(timeout time.Duration) ClientOrHTTPClientParam

+ func WithHTTP2ReadIdleTimeout(timeout time.Duration) ClientOrHTTPClientParam

Jun 16, 2021

Changes in this version

+ type StaticTagsProvider metrics.Tags

+ func (s StaticTagsProvider) Tags(_ *http.Request, _ *http.Response, _ error) metrics.Tags

May 12, 2021

Changes in this version

+ func LocationFromError(err error) (location string, ok bool)

Mar 22, 2021

Changes in this version

type ClientOrHTTPClientParam

+ func WithTLSInsecureSkipVerify() ClientOrHTTPClientParam

Feb 3, 2021

Changes in this version

type ClientParam

+ func WithUnlimitedRetries() ClientParam

Dec 16, 2020

Changes in this version

+ const MetricConnCreate

+ const MetricConnInflight

+ const MetricRequestInFlight

+ var MetricTagConnectionNew = metrics.MustNewTag("reused", "false")

+ var MetricTagConnectionReused = metrics.MustNewTag("reused", "true")

type ClientConfig

+ MaxIdleConns *int

+ MaxIdleConnsPerHost *int

Dec 3, 2020

Changes in this version

+ const CipherTagKey

+ const MetricTLSHandshake

+ const MetricTLSHandshakeAttempt

+ const MetricTLSHandshakeFailure

+ const MetricTagServiceName

+ const NextProtocolTagKey

+ const TLSVersionTagKey

May 15, 2020

Changes in this version

type ClientParam

+ func WithDisableKeepAlives() ClientParam

May 7, 2020

Changes in this version

+ func ContextWithRPCMethodName(ctx context.Context, name string) context.Context

+ func NewHTTPClient(params ...HTTPClientParam) (*http.Client, error)

+ func StatusCodeFromError(err error) (statusCode int, ok bool)

+ type Client interface

+ Delete func(ctx context.Context, params ...RequestParam) (*http.Response, error)

+ Do func(ctx context.Context, params ...RequestParam) (*http.Response, error)

+ Get func(ctx context.Context, params ...RequestParam) (*http.Response, error)

+ Head func(ctx context.Context, params ...RequestParam) (*http.Response, error)

+ Post func(ctx context.Context, params ...RequestParam) (*http.Response, error)

+ Put func(ctx context.Context, params ...RequestParam) (*http.Response, error)

+ func NewClient(params ...ClientParam) (Client, error)

+ type ClientConfig struct

+ APIToken *string

+ APITokenFile *string

+ ConnectTimeout *time.Duration

+ DisableHTTP2 *bool

+ ExpectContinueTimeout *time.Duration

+ IdleConnTimeout *time.Duration

+ InitialBackoff *time.Duration

+ MaxBackoff *time.Duration

+ MaxNumRetries *int

+ Metrics MetricsConfig

+ ProxyFromEnvironment *bool

+ ProxyURL *string

+ ReadTimeout *time.Duration

+ Security SecurityConfig

+ ServiceName string

+ TLSHandshakeTimeout *time.Duration

+ URIs []string

+ WriteTimeout *time.Duration

+ type ClientOrHTTPClientParam interface

+ func WithAddHeader(key, value string) ClientOrHTTPClientParam

+ func WithAuthToken(bearerToken string) ClientOrHTTPClientParam

+ func WithAuthTokenProvider(provideToken TokenProvider) ClientOrHTTPClientParam

+ func WithBytesBufferPool(pool bytesbuffers.Pool) ClientOrHTTPClientParam

+ func WithDialTimeout(timeout time.Duration) ClientOrHTTPClientParam

+ func WithDisableHTTP2() ClientOrHTTPClientParam

+ func WithDisablePanicRecovery() ClientOrHTTPClientParam

+ func WithDisableTracing() ClientOrHTTPClientParam

+ func WithExpectContinueTimeout(timeout time.Duration) ClientOrHTTPClientParam

+ func WithHTTPTimeout(timeout time.Duration) ClientOrHTTPClientParam

+ func WithIdleConnTimeout(timeout time.Duration) ClientOrHTTPClientParam

+ func WithKeepAlive(keepAlive time.Duration) ClientOrHTTPClientParam

+ func WithMaxIdleConns(conns int) ClientOrHTTPClientParam

+ func WithMaxIdleConnsPerHost(conns int) ClientOrHTTPClientParam

+ func WithMetrics(tagProviders ...TagsProvider) ClientOrHTTPClientParam

+ func WithMiddleware(h Middleware) ClientOrHTTPClientParam

+ func WithNoProxy() ClientOrHTTPClientParam

+ func WithProxyFromEnvironment() ClientOrHTTPClientParam

+ func WithProxyURL(proxyURLString string) ClientOrHTTPClientParam

+ func WithResponseHeaderTimeout(timeout time.Duration) ClientOrHTTPClientParam

+ func WithServiceName(serviceName string) ClientOrHTTPClientParam

+ func WithSetHeader(key, value string) ClientOrHTTPClientParam

+ func WithTLSConfig(conf *tls.Config) ClientOrHTTPClientParam

+ func WithTLSHandshakeTimeout(timeout time.Duration) ClientOrHTTPClientParam

+ func WithUserAgent(userAgent string) ClientOrHTTPClientParam

+ type ClientParam interface

+ func WithBaseURLs(urls []string) ClientParam

+ func WithBasicAuth(username, password string) ClientParam

+ func WithConfig(c ClientConfig) ClientParam

+ func WithDisableRestErrors() ClientParam

+ func WithDisableTraceHeaderPropagation() ClientParam

+ func WithErrorDecoder(errorDecoder ErrorDecoder) ClientParam

+ func WithInitialBackoff(initialBackoff time.Duration) ClientParam

+ func WithMaxBackoff(maxBackoff time.Duration) ClientParam

+ func WithMaxRetries(maxTransportRetries int) ClientParam

+ type ErrorDecoder interface

+ DecodeError func(resp *http.Response) error

+ Handles func(resp *http.Response) bool

+ type HTTPClientParam interface

+ func WithConfigForHTTPClient(c ClientConfig) HTTPClientParam

+ type MetricsConfig struct

+ Enabled *bool

+ Tags map[string]string

+ type Middleware interface

+ RoundTrip func(req *http.Request, next http.RoundTripper) (*http.Response, error)

+ func MetricsMiddleware(serviceName string, tagProviders ...TagsProvider) (Middleware, error)

+ type MiddlewareFunc func(req *http.Request, next http.RoundTripper) (*http.Response, error)

+ func (f MiddlewareFunc) RoundTrip(req *http.Request, next http.RoundTripper) (*http.Response, error)

+ type RequestParam interface

+ func WithCompressedRequest(input interface{}, codec codecs.Codec) RequestParam

+ func WithHeader(key, value string) RequestParam

+ func WithJSONRequest(input interface{}) RequestParam

+ func WithJSONResponse(output interface{}) RequestParam

+ func WithPath(path string) RequestParam

+ func WithPathf(format string, args ...interface{}) RequestParam

+ func WithQueryValues(query url.Values) RequestParam

+ func WithRPCMethodName(name string) RequestParam

+ func WithRawRequestBody(input io.ReadCloser) RequestParam

+ func WithRawRequestBodyProvider(getBody func() io.ReadCloser) RequestParam

+ func WithRawResponseBody() RequestParam

+ func WithRequestBasicAuth(username, password string) RequestParam

+ func WithRequestBody(input interface{}, encoder codecs.Encoder) RequestParam

+ func WithRequestErrorDecoder(errorDecoder ErrorDecoder) RequestParam

+ func WithRequestMethod(method string) RequestParam

+ func WithResponseBody(output interface{}, decoder codecs.Decoder) RequestParam

+ type SecurityConfig struct

+ CAFiles []string

+ CertFile string

+ KeyFile string

+ type ServicesConfig struct

+ Default ClientConfig

+ Services map[string]ClientConfig

+ func (c ServicesConfig) ClientConfig(serviceName string) ClientConfig

+ func (c ServicesConfig) MustClientConfig(serviceName string) (ClientConfig, error)

+ type TagsProvider interface

+ Tags func(*http.Request, *http.Response) metrics.Tags

+ type TagsProviderFunc func(*http.Request, *http.Response) metrics.Tags

+ func (f TagsProviderFunc) Tags(req *http.Request, resp *http.Response) metrics.Tags

+ type TokenProvider func(context.Context) (string, error)