httpkit

Documentation

Index

• func NewClient(options ...ClientOption) *http.Client
• func ProfilerMiddleware() http.Handler
• type ClientOption
  • func WithCustomDialer(dialer CustomDialer) ClientOption
  • func WithDialTimeout(timeout time.Duration) ClientOption
  • func WithKeepAliveDisabled(disabled bool) ClientOption
  • func WithKeepAliveTimeout(timeout time.Duration) ClientOption
  • func WithMaxIdleConns(max int) ClientOption
  • func WithMaxIdleConnsPerHost(max int) ClientOption
  • func WithReadBufferSize(size int) ClientOption
  • func WithResponseHeaderTimeout(timeout time.Duration) ClientOption
  • func WithRetries(options ...retry.Option) ClientOption
  • func WithTLSHandshakeTimeout(timeout time.Duration) ClientOption
  • func WithWriteBufferSize(size int) ClientOption
• type Config
• type CustomDialer
• type HealthConfig
• type ListenerConfig
• type ListenerHTTP
  • func NewListenerHTTP(addr string, options ...ListenerOption[ListenerConfig]) (*ListenerHTTP, error)
  • func (l *ListenerHTTP) Mount(route string, handler http.Handler, middlewares ...Middleware)
  • func (l *ListenerHTTP) MountGroup(route string, fn func(r chi.Router))
  • func (l *ListenerHTTP) Serve(ctx context.Context) error
• type ListenerOption
  • func HTTPServerIdleTimeout(t time.Duration) ListenerOption[TimeoutsConfig]
  • func HTTPServerReadHeaderTimeout(t time.Duration) ListenerOption[TimeoutsConfig]
  • func HTTPServerReadTimeout(t time.Duration) ListenerOption[TimeoutsConfig]
  • func HTTPServerWriteTimeout(t time.Duration) ListenerOption[TimeoutsConfig]
  • func HealthCheckAccessLog(enable bool) ListenerOption[HealthConfig]
  • func HealthCheckMetricsForEndpoint(enable bool) ListenerOption[HealthConfig]
  • func HealthCheckRoute(route string) ListenerOption[HealthConfig]
  • func HealthChecker(checker hc.HealthChecker) ListenerOption[HealthConfig]
  • func MetricsAccessLog(enable bool) ListenerOption[MetricsConfig]
  • func MetricsMetricsForEndpoint(enable bool) ListenerOption[MetricsConfig]
  • func MetricsRoute(route string) ListenerOption[MetricsConfig]
  • func NewListenerOption[T ListenerOptionConstraint](options ...ListenerOption[T]) []ListenerOption[T]
  • func WithGlobalMiddlewares(middlewares ...Middleware) ListenerOption[ListenerConfig]
  • func WithHTTPServerTimeouts(options ...ListenerOption[TimeoutsConfig]) ListenerOption[ListenerConfig]
  • func WithHealthCheck(options ...ListenerOption[HealthConfig]) ListenerOption[ListenerConfig]
  • func WithLogger(logger *slog.Logger) ListenerOption[ListenerConfig]
  • func WithMetrics(options ...ListenerOption[MetricsConfig]) ListenerOption[ListenerConfig]
  • func WithProfiler(cfg PPROFConfig) ListenerOption[ListenerConfig]
  • func WithTLS(cert, key string) ListenerOption[ListenerConfig]
• type ListenerOptionConstraint
• type MetricsConfig
• type Middleware
  • func CORSMiddleware(o cors.Options) Middleware
  • func LoggingMiddleware(logger *slog.Logger) Middleware
  • func MetricsMiddleware() Middleware
  • func RecoveryMiddleware() Middleware
  • func RedirectSlashesMiddleware() Middleware
• type PPROFConfig
• type TimeoutsConfig

Functions

func NewClient

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

NewClient takes options to configure and return a pointer to a new instance of http.Client.

func ProfilerMiddleware

func ProfilerMiddleware() http.Handler

Types

type ClientOption

type ClientOption func(config *Config)

ClientOption represents functional options pattern for Config type. ClientOption type represents a function which receive a pointer Config struct. ClientOption functions can only be passed to NewClient function. ClientOption function can change the default value of Config struct fields.

func WithCustomDialer

func WithCustomDialer(dialer CustomDialer) ClientOption

WithCustomDialer sets given dialer as custom net.Dialer underlying http.Transport of http.Client.

func WithDialTimeout

func WithDialTimeout(timeout time.Duration) ClientOption

WithDialTimeout sets the Dial timeout to underlying http.Transport of http.Client.

func WithKeepAliveDisabled

func WithKeepAliveDisabled(disabled bool) ClientOption

WithKeepAliveDisabled sets the

func WithKeepAliveTimeout

func WithKeepAliveTimeout(timeout time.Duration) ClientOption

WithKeepAliveTimeout sets the KeepAlive timeout to underlying http.Transport of http.Client.

func WithMaxIdleConns

func WithMaxIdleConns(max int) ClientOption

WithMaxIdleConns sets the MaxIdleConns value to underlying http.Transport of http.Client.

func WithMaxIdleConnsPerHost

func WithMaxIdleConnsPerHost(max int) ClientOption

WithMaxIdleConnsPerHost sets the MaxIdleConnsPerHost value to underlying http.Transport of http.Client.

func WithReadBufferSize

func WithReadBufferSize(size int) ClientOption

WithReadBufferSize sets the ReadBufferSize value to underlying http.Transport of http.Client.

func WithResponseHeaderTimeout

func WithResponseHeaderTimeout(timeout time.Duration) ClientOption

WithResponseHeaderTimeout sets the ResponseHeaderTimeout value to underlying http.Transport of http.Client.

func WithRetries

func WithRetries(options ...retry.Option) ClientOption

WithRetries configure http.Client to do retries when request failed and retry could be made.

func WithTLSHandshakeTimeout

func WithTLSHandshakeTimeout(timeout time.Duration) ClientOption

WithTLSHandshakeTimeout sets timeout for TLS handshake to underlying http.Transport of http.Client, after which connection will be terminated.

func WithWriteBufferSize

func WithWriteBufferSize(size int) ClientOption

WithWriteBufferSize sets the WriteBufferSize value to underlying http.Transport of http.Client.

type Config

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

Config holds configuration options which will be applied to http.Client.

type CustomDialer

type CustomDialer interface {
	// DialContext connects to the address on the named network using
	// the provided context.
	DialContext(ctx context.Context, network, address string) (net.Conn, error)
}

CustomDialer holds logic of establishing connection to remote network address.

type HealthConfig

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

HealthConfig represents configuration for builtin health check route.

type ListenerConfig

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

ListenerConfig holds ListenerHTTP configuration.

type ListenerHTTP

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

func NewListenerHTTP

func NewListenerHTTP(addr string, options ...ListenerOption[ListenerConfig]) (*ListenerHTTP, error)

NewListenerHTTP creates a new ListenerHTTP with the specified address and options. The options parameter is a variadic argument that accepts functions of type ListenerOption. The ListenerHTTP instance is returned, which can be used to mount routes and start serving requests.

func (*ListenerHTTP) Mount

func (l *ListenerHTTP) Mount(route string, handler http.Handler, middlewares ...Middleware)

func (*ListenerHTTP) MountGroup

func (l *ListenerHTTP) MountGroup(route string, fn func(r chi.Router))

func (*ListenerHTTP) Serve

func (l *ListenerHTTP) Serve(ctx context.Context) error

type ListenerOption

type ListenerOption[T ListenerOptionConstraint] func(o *T)

ListenerOption implements functional options pattern for the ListenerHTTP type. Represents a function which receive a pointer to the generic struct that represents a part of ListenerHTTP configuration and changes it default values to the given ones.

See the applyOptionsHTTP function to understand the configuration behaviour. ListenerOption functions should only be passed to ListenerHTTP constructor function NewListenerHTTP.

func HTTPServerIdleTimeout

func HTTPServerIdleTimeout(t time.Duration) ListenerOption[TimeoutsConfig]

HTTPServerIdleTimeout sets the http.Server IdleTimeout.

func HTTPServerReadHeaderTimeout

func HTTPServerReadHeaderTimeout(t time.Duration) ListenerOption[TimeoutsConfig]

HTTPServerReadHeaderTimeout sets the http.Server ReadHeaderTimeout.

func HTTPServerReadTimeout

func HTTPServerReadTimeout(t time.Duration) ListenerOption[TimeoutsConfig]

HTTPServerReadTimeout sets the http.Server ReadTimeout.

func HTTPServerWriteTimeout

func HTTPServerWriteTimeout(t time.Duration) ListenerOption[TimeoutsConfig]

HTTPServerWriteTimeout sets the http.Server WriteTimeout.

func HealthCheckAccessLog

func HealthCheckAccessLog(enable bool) ListenerOption[HealthConfig]

HealthCheckAccessLog represents an optional function for WithHealthCheck function. If passed to the WithHealthCheck, will set the ServerSettings.health.accessLogsEnabled to true.

func HealthCheckMetricsForEndpoint

func HealthCheckMetricsForEndpoint(enable bool) ListenerOption[HealthConfig]

HealthCheckMetricsForEndpoint represents an optional function for WithHealthCheck function. If passed to the WithHealthCheck, will set the ServerSettings.health.metricsForEndpointEnabled to true.

func HealthCheckRoute

func HealthCheckRoute(route string) ListenerOption[HealthConfig]

HealthCheckRoute represents an optional function for WithHealthCheck function. If passed to the WithHealthCheck, will set the ServerSettings.health.route.

func HealthChecker

func HealthChecker(checker hc.HealthChecker) ListenerOption[HealthConfig]

HealthChecker represents an optional function for WithHealthCheck function. If passed to the WithHealthCheck, will set the ServerSettings.health.healthChecker.

func MetricsAccessLog

func MetricsAccessLog(enable bool) ListenerOption[MetricsConfig]

MetricsAccessLog represents an optional function for WithMetrics function. If passed to the WithMetrics, will set the ServerSettings.health.accessLogsEnabled to true.

func MetricsMetricsForEndpoint

func MetricsMetricsForEndpoint(enable bool) ListenerOption[MetricsConfig]

MetricsMetricsForEndpoint represents an optional function for WithMetrics function. If passed to the WithMetrics, will set the ServerSettings.health.metricsForEndpointEnabled to true.

func MetricsRoute

func MetricsRoute(route string) ListenerOption[MetricsConfig]

MetricsRoute represents an optional function for WithMetrics function. If passed to the WithMetrics, will set the ServerSettings.health.route.

func NewListenerOption

func NewListenerOption[T ListenerOptionConstraint](options ...ListenerOption[T]) []ListenerOption[T]

NewListenerOption returns a slice of ListenerOption[T].

func WithGlobalMiddlewares

func WithGlobalMiddlewares(middlewares ...Middleware) ListenerOption[ListenerConfig]

WithGlobalMiddlewares sets given middlewares as router-wide middlewares. Means that they will be applied to each server endpoint.

func WithHTTPServerTimeouts

func WithHTTPServerTimeouts(options ...ListenerOption[TimeoutsConfig]) ListenerOption[ListenerConfig]

WithHTTPServerTimeouts configures the HTTP listener TimeoutsConfig. Receives the following option to configure the endpoint: - HTTPServerReadHeaderTimeout - sets the http.Server ReadHeaderTimeout. - HTTPServerReadTimeout - sets the http.Server ReadTimeout. - HTTPServerWriteTimeout - sets the http.Server WriteTimeout. - HTTPServerIdleTimeout - sets the http.Server IdleTimeout.

func WithHealthCheck

func WithHealthCheck(options ...ListenerOption[HealthConfig]) ListenerOption[ListenerConfig]

WithHealthCheck turns on the health check endpoint. Receives the following option to configure the endpoint: - HealthChecker - to change the healthChecker implementation. - HealthCheckRoute - to set the endpoint route. - HealthCheckAccessLog - to enable access log for endpoint. - HealthCheckMetricsForEndpoint - to enable metrics collection for endpoint.

func WithLogger

func WithLogger(logger *slog.Logger) ListenerOption[ListenerConfig]

WithLogger sets the server logger.

func WithMetrics

func WithMetrics(options ...ListenerOption[MetricsConfig]) ListenerOption[ListenerConfig]

WithMetrics turns on the metrics endpoint. Receives the following option to configure the endpoint: - MetricsRoute - to set the endpoint route. - MetricsAccessLog - to enable access log for endpoint. - MetricsMetricsForEndpoint - to enable metrics collection for endpoint.

func WithProfiler

func WithProfiler(cfg PPROFConfig) ListenerOption[ListenerConfig]

WithProfiler turns on the profiler endpoint.

func WithTLS

func WithTLS(cert, key string) ListenerOption[ListenerConfig]

WithTLS sets the TLS certificate and key to be used by the HTTP server. The certificate and key must be provided as strings containing the file paths. Note that this function is an ListenerOption for ListenerConfig and should be passed to the NewServer constructor.

type ListenerOptionConstraint

type ListenerOptionConstraint interface {
	ListenerConfig | TimeoutsConfig | HealthConfig | MetricsConfig | PPROFConfig
}

ListenerOptionConstraint represents a constraint for generic types that are related to ListenerOption.

type MetricsConfig

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

MetricsConfig represents configuration for builtin metrics route.

type Middleware

type Middleware = func(next http.Handler) http.Handler

Middleware represents a function type that serves as a middleware in an HTTP server. It takes the next http.Handler as a parameter and returns an http.Handler. The middleware function is responsible for intercepting and processing HTTP requests and responses.

func CORSMiddleware

func CORSMiddleware(o cors.Options) Middleware

func LoggingMiddleware

func LoggingMiddleware(logger *slog.Logger) Middleware

LoggingMiddleware represents logging middleware.

func MetricsMiddleware

func MetricsMiddleware() Middleware

MetricsMiddleware represents HTTP metrics collecting middlewares.

func RecoveryMiddleware

func RecoveryMiddleware() Middleware

func RedirectSlashesMiddleware

func RedirectSlashesMiddleware() Middleware

type PPROFConfig

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

PPROFConfig represents configuration for builtin profiler route.

type TimeoutsConfig

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

TimeoutsConfig holds an HTTP server TimeoutsConfig configuration.