http

Documentation

Index

• func DecodeJSON(req *http.Request, obj interface{}) error
• func NewClient(cfg *ClientConfig) (*http.Client, error)
• func NewTransport(cfg *TransportConfig) (*http.Transport, error)
• func ParseQuery(req *http.Request, obj interface{}) error
• func WriteError(rw http.ResponseWriter, statusCode int, err error)
• func WriteJSON(rw http.ResponseWriter, statusCode int, data interface{}) error
• type ClientConfig
  • func (cfg *ClientConfig) SetDefault() *ClientConfig
• type ErrorRespMsg
• type Server
  • func NewServer(cfg *ServerConfig) (*Server, error)
  • func (s *Server) Done() chan struct{}
  • func (s *Server) Error() error
  • func (s *Server) Logger() logrus.FieldLogger
  • func (s *Server) SetHandler(h http.Handler) *Server
  • func (s *Server) SetLogger(logger logrus.FieldLogger)
  • func (s *Server) Start(ctx context.Context) error
  • func (s *Server) Stop(ctx context.Context) error
• type ServerConfig
  • func (cfg *ServerConfig) SetDefault() *ServerConfig
• type ServerFlagPrefixer
  • func NewServerFlagPrefixer(name, defaultAddr string) ServerFlagPrefixer
  • func (fl *ServerFlagPrefixer) ConfigFromViper(v *viper.Viper) *ServerConfig
  • func (fl *ServerFlagPrefixer) Flags(v *viper.Viper, f *pflag.FlagSet)
• type TransportConfig
  • func (cfg *TransportConfig) SetDefault() *TransportConfig

Functions

func DecodeJSON

func DecodeJSON(req *http.Request, obj interface{}) error

func NewClient

func NewClient(cfg *ClientConfig) (*http.Client, error)

New creates a new HTTP client

func NewTransport

func NewTransport(cfg *TransportConfig) (*http.Transport, error)

NewTransport creates a http.Transport

func ParseQuery

func ParseQuery(req *http.Request, obj interface{}) error

func WriteError

func WriteError(rw http.ResponseWriter, statusCode int, err error)

func WriteJSON

func WriteJSON(rw http.ResponseWriter, statusCode int, data interface{}) error

Types

type ClientConfig

type ClientConfig struct {
	Transport *TransportConfig    `json:"transport,omitempty"`
	Timeout   *kilntypes.Duration `json:"timeout,omitempty"`
}

Config for creating an HTTP Client

func (*ClientConfig) SetDefault

func (cfg *ClientConfig) SetDefault() *ClientConfig

type ErrorRespMsg

type ErrorRespMsg struct {
	Message string `json:"message" example:"error message"`
	Code    string `json:"status,omitempty" example:"IR001"`

} // @name Error

type Server

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

func NewServer

func NewServer(cfg *ServerConfig) (*Server, error)

func (*Server) Done

func (s *Server) Done() chan struct{}

func (*Server) Error

func (s *Server) Error() error

func (*Server) Logger

func (s *Server) Logger() logrus.FieldLogger

func (*Server) SetHandler

func (s *Server) SetHandler(h http.Handler) *Server

func (*Server) SetLogger

func (s *Server) SetLogger(logger logrus.FieldLogger)

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

type ServerConfig

type ServerConfig struct {
	Entrypoint *kilnnet.EntrypointConfig

	ReadTimeout       *types.Duration
	ReadHeaderTimeout *types.Duration

	WriteTimeout *types.Duration

	IdleTimeout *types.Duration

	MaxHeaderBytes *int
}

func (*ServerConfig) SetDefault

func (cfg *ServerConfig) SetDefault() *ServerConfig

type ServerFlagPrefixer

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

func NewServerFlagPrefixer

func NewServerFlagPrefixer(name, defaultAddr string) ServerFlagPrefixer

func (*ServerFlagPrefixer) ConfigFromViper

func (fl *ServerFlagPrefixer) ConfigFromViper(v *viper.Viper) *ServerConfig

func (*ServerFlagPrefixer) Flags

func (fl *ServerFlagPrefixer) Flags(v *viper.Viper, f *pflag.FlagSet)

type TransportConfig

type TransportConfig struct {
	Dialer                *kilnnet.DialerConfig
	IdleConnTimeout       *kilntypes.Duration
	ResponseHeaderTimeout *kilntypes.Duration
	ExpectContinueTimeout *kilntypes.Duration
	MaxIdleConnsPerHost   int
	MaxConnsPerHost       int
	DisableKeepAlives     bool
	DisableCompression    bool
	EnableHTTP2           bool

	TLS *kilntls.Config
}

TransportConfig options to configure communication between Traefik and the servers

func (*TransportConfig) SetDefault

func (cfg *TransportConfig) SetDefault() *TransportConfig