httpserver

README

httpserver

Documentation

Index

• func Run(ctx context.Context, port uint16, handler http.Handler, opts ...Opt) error
• type Opt
  • func WithAddress(host string, port uint16) Opt
  • func WithHandler(handler http.Handler) Opt
  • func WithIdleTimeout(d time.Duration) Opt
  • func WithMaxHeaderBytes(i int) Opt
  • func WithReadHeaderTimeout(d time.Duration) Opt
  • func WithReadTimeout(d time.Duration) Opt
  • func WithShutdownTimeout(d time.Duration) Opt
  • func WithTLSConfig(conf *tls.Config) Opt
  • func WithWriteTimeout(d time.Duration) Opt
• type Server
  • func New(opts ...Opt) *Server
  • func (s *Server) Run(ctx context.Context) error

Functions

func Run

func Run(ctx context.Context, port uint16, handler http.Handler, opts ...Opt) error

Run is a shortcut for New(...).Run(ctx). Port and handler parameters take precedence over the WithAddress and WithHandler options respectively if they are passed too

Types

type Opt

type Opt func(*Server)

func WithAddress

func WithAddress(host string, port uint16) Opt

func WithHandler

func WithHandler(handler http.Handler) Opt

func WithIdleTimeout

func WithIdleTimeout(d time.Duration) Opt

func WithMaxHeaderBytes

func WithMaxHeaderBytes(i int) Opt

func WithReadHeaderTimeout

func WithReadHeaderTimeout(d time.Duration) Opt

func WithReadTimeout

func WithReadTimeout(d time.Duration) Opt

func WithShutdownTimeout

func WithShutdownTimeout(d time.Duration) Opt

func WithTLSConfig

func WithTLSConfig(conf *tls.Config) Opt

func WithWriteTimeout

func WithWriteTimeout(d time.Duration) Opt

type Server

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

Server is a http server

func New

func New(opts ...Opt) *Server

New creates new Server with given options. Default options: - read timeout 30s - write timeout 30s - shutdown timeout 15s

func (*Server) Run

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

Run runs http server and gracefully shuts it down on context cancellation. It works well in conjunction with custom os signals handling via context (signal.NotifyContext)