timeouthttp

README

go-timeout-httpclient

Yet another HTTP Client with configurable timeouts

Usage

import "github.com/pteich/go-timeout-httpclient"

httpClient := timeouthttp.NewClient(timeouthttp.Config{
    RequestTimeout: 5,
    ConnectTimeout: 5,
})

Documentation

Index

• func DefaultPooledTransport(config Config) *http.Transport
• func DefaultTransport(config Config) *http.Transport
• func New(opts ...Option) *http.Client
• func NewClient(config Config) *http.Client
• func NewPooledClient(config Config) *http.Client
• type Config
• type Option
  • func WithConnectTimeout(timeout int) Option
  • func WithKeepAliveTimeout(timeout int) Option
  • func WithMaxIdleConnections(count int) Option
  • func WithRequestTimeout(timeout int) Option
  • func WithTimeout(timeout int) Option

Functions

func DefaultPooledTransport

func DefaultPooledTransport(config Config) *http.Transport

func DefaultTransport

func DefaultTransport(config Config) *http.Transport

func New

func New(opts ...Option) *http.Client

New returns a new clean HTTP.Client with variable options set

func NewClient

func NewClient(config Config) *http.Client

NewClient returns a new clean HTTP.Client with timeouts (default 1s for connection and request), disabled idle connections and disabled keep-alives

func NewPooledClient

func NewPooledClient(config Config) *http.Client

NewPooledClient returns a new clean HTTP.Client with timeouts (default 1s for connection and request) and shared transport across hosts with keepalive on, you can set the number of idle connections per host with Config.MaxIdleConnsPerHost (default 1)

Types

type Config

type Config struct {
	ConnectTimeout            int
	RequestTimeout            int
	KeepAliveTimeout          int
	MaxIdleConnectionsPerHost int
	KeepAlive                 bool
}

Config defines timeouts and max idle connections per host if pooled transport is used all timeouts are seconds

type Option

type Option func(c *Config)

func WithConnectTimeout

func WithConnectTimeout(timeout int) Option

func WithKeepAliveTimeout

func WithKeepAliveTimeout(timeout int) Option

func WithMaxIdleConnections

func WithMaxIdleConnections(count int) Option

func WithRequestTimeout

func WithRequestTimeout(timeout int) Option

func WithTimeout

func WithTimeout(timeout int) Option