server

Documentation

Index

• type Server
  • func NewServer(c *cfg.Config) (*Server, error)
  • func (s *Server) AddContext(parent context.Context, next http.Handler) http.Handler
  • func (s *Server) AddRoutes(ctx context.Context, router *mux.Router, chain alice.Chain) http.Handler
  • func (s *Server) HealthCheckHandler(rw http.ResponseWriter, req *http.Request)
  • func (s *Server) Serve(ctx context.Context) error
  • func (s *Server) WithMetrics(next http.Handler) http.Handler

Types

type Server

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

Server is our HTTP server implementation.

func NewServer

func NewServer(c *cfg.Config) (*Server, error)

NewServer constructs a server from the provided parameters.

func (*Server) AddContext

func (s *Server) AddContext(parent context.Context, next http.Handler) http.Handler

AddContext adds the accociated server's context to the provided http.Hander request.

func (*Server) AddRoutes

func (s *Server) AddRoutes(ctx context.Context, router *mux.Router, chain alice.Chain) http.Handler

AddRoutes add the accociated Servers URL routes to the provided router with the provided context.Context.

func (*Server) HealthCheckHandler

func (s *Server) HealthCheckHandler(rw http.ResponseWriter, req *http.Request)

HealthCheckHandler a http handler return 200 OK when server health is fine.

func (*Server) Serve

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

Serve starts all the accociated servers resources and listeners and blocks forever until signals or error occurs. Returns error and gracefully stops all HTTP listeners before return.

func (*Server) WithMetrics

func (s *Server) WithMetrics(next http.Handler) http.Handler

WithMetrics adds metrics logging to the provided http.Handler. When the handler is done, the context is canceled, logging metrics.