stdhttpserverfx

Documentation

Overview

Package stdhttpserverfx provides a web server.

Index

• func Provide() fx.Option
• type Config
• type Params
• type Result
  • func New(params Params) (Result, error)

Functions

func Provide

func Provide() fx.Option

Provide dependencies.

Types

type Config

type Config struct {
	// BindAddrPort configures where the web server will listen for incoming tcp traffic
	BindAddrPort string `env:"BIND_ADDR_PORT" envDefault:"0.0.0.0:8282"`
	// HTTP read timeout, See: https://blog.cloudflare.com/exposing-go-on-the-internet/
	ReadTimeout time.Duration `env:"READ_TIMEOUT" envDefault:"5s"`
	// HTTP read header timeout, See: https://blog.cloudflare.com/exposing-go-on-the-internet/
	ReadHeaderTimeout time.Duration `env:"READ_HEADER_TIMEOUT" envDefault:"5s"`
	// HTTP write timeout, See: https://blog.cloudflare.com/exposing-go-on-the-internet/
	WriteTimeout time.Duration `env:"WRITE_TIMEOUT" envDefault:"12s"`
	// HTTP idle timeout, See: https://blog.cloudflare.com/exposing-go-on-the-internet/
	IdleTimeout time.Duration `env:"IDLE_TIMEOUT" envDefault:"120s"`
}

Config configures the package.

type Params

type Params struct {
	fx.In
	fx.Lifecycle

	Config   Config
	Logs     *zap.Logger
	Handler  http.Handler
	Listener *net.TCPListener
}

Params describe the fx parameters.

type Result

type Result struct {
	fx.Out
	Server *http.Server
}

Result describe the fx results.

func New

func New(params Params) (Result, error)

New inits the http server.