httpserver

README

A Simple Golang Server with Graceful shutdown

Note This library doesn't handle routing

Usage

Check out example directory!

Documentation

Index

• type Option
  • func WithLogger(logger *slog.Logger) Option
  • func WithServerTimeouts(readTimeout, writeTimeout, idleTimeout time.Duration) Option
  • func WithShutdownTimeout(timeout time.Duration) Option
• type Server
  • func New(address string, port uint, handler http.Handler, options ...Option) *Server
  • func (s *Server) AddShutdownHook(hook func(context.Context) error)
  • func (s *Server) Context() context.Context
  • func (s *Server) Run() error

Types

type Option

type Option func(*Server)

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger configures error and server logger

func WithServerTimeouts

func WithServerTimeouts(readTimeout, writeTimeout, idleTimeout time.Duration) Option

WithServerTimeouts configures "net/http".Server ReadTimeout, WriteTimeout and IdleTimeout

func WithShutdownTimeout

func WithShutdownTimeout(timeout time.Duration) Option

WithShutdownTimeout so server doesn't exceed the provided duration after receiving a stop signal

type Server

type Server struct {
	HTTPServer *http.Server
	// contains filtered or unexported fields
}

func New

func New(address string, port uint, handler http.Handler, options ...Option) *Server

func (*Server) AddShutdownHook

func (s *Server) AddShutdownHook(hook func(context.Context) error)

func (*Server) Context

func (s *Server) Context() context.Context

func (*Server) Run

func (s *Server) Run() error