httpServer

Documentation

Index

• type Server
  • func New(port string) (*Server, error)
  • func (s *Server) ServeHTTP(ctx context.Context, srv *http.Server) error
  • func (s *Server) ServeHTTPWithHandler(ctx context.Context, handler http.Handler) error
  • func (s *Server) ServeHTTPWithObservabilityHandler(ctx context.Context, handler http.Handler) error

Types

type Server

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

Server provides a gracefolly-stoppable http server implementation. It is safe for concurrent use in goroutines

func New

func New(port string) (*Server, error)

New creates a new server listening on the provided address that responds to the http.Handler. It starts the listener, but does not start the server. If an empty port is given, the server randomly chooses one.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(ctx context.Context, srv *http.Server) error

ServeHTTP starts the server and blocks until the provided context is closed. When the provided context is closed, the server is gracefully stopped with a timeout of 5 seconds.

Once a server has been stopped, it is NOT safe for reuse.

func (*Server) ServeHTTPWithHandler

func (s *Server) ServeHTTPWithHandler(ctx context.Context, handler http.Handler) error

func (*Server) ServeHTTPWithObservabilityHandler

func (s *Server) ServeHTTPWithObservabilityHandler(ctx context.Context, handler http.Handler) error

ServeHTTPHandler is a convenience wrapper around ServeHTTP. It creates an HTTP server using the provided handler, wrapped in OpenCensus for observability.