httpsrv

Documentation

Index

• Variables
• func NewHTTPServer(logger slice.Logger, handler http.Handler, params *Parameters) *http.Server
• func RegisterHTTPControllers(logger slice.Logger, container *di.Container, mux *http.ServeMux) error
• type Controller
• type Parameters
  • func DefaultParameters() *Parameters

Variables

var Bundle = bundle.New(
	bundle.WithName("http"),
	bundle.WithParameters(
		DefaultParameters(),
	),
	bundle.WithComponents(
		slice.Provide(NewHTTPServer),
		slice.Provide(http.NewServeMux, di.As(new(http.Handler))),
	),
	bundle.WithHooks(
		slice.Hook{
			BeforeStart: RegisterHTTPControllers,
		},
	),
)

Bundle

Functions

func NewHTTPServer

func NewHTTPServer(logger slice.Logger, handler http.Handler, params *Parameters) *http.Server

NewHTTPServer

func RegisterHTTPControllers

func RegisterHTTPControllers(logger slice.Logger, container *di.Container, mux *http.ServeMux) error

RegisterHTTPControllers

Types

type Controller

type Controller interface {
	RegisterRoutes(mux *http.ServeMux)
}

Controller

type Parameters

type Parameters struct {
	Addr         string        `envconfig:"addr" required:"true" desc:"Server address"`
	ReadTimeout  time.Duration `envconfig:"read_timeout" required:"true" desc:"Server read timeout"`
	WriteTimeout time.Duration `envconfig:"write_timeout" required:"true" desc:"Server write timeout"`
}

Parameters contains application configuration.

func DefaultParameters

func DefaultParameters() *Parameters

DefaultParameters returns default application parameters.