net

Documentation

Index

• type HTTPServer
  • func NewHTTPServer(s *http.Server) *HTTPServer
  • func (h *HTTPServer) ListenAndServe() error
  • func (h *HTTPServer) Listener() net.Listener
  • func (h *HTTPServer) Shutdown(ctx context.Context) error

Types

type HTTPServer

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

HTTPServer wraps an http.Server to listen asynchronously and allow stopping it.

func NewHTTPServer

func NewHTTPServer(s *http.Server) *HTTPServer

NewHTTPServer wraps the given http.Server into an HTTPServer.

func (*HTTPServer) ListenAndServe

func (h *HTTPServer) ListenAndServe() error

ListenAndServe starts the given HTTP server up in the background and returns immediately. The server listens on the configured Addr or ":http" if unconfigured.

An error is returned if the server failed to start up, if the server was already listening, or if the server was stopped with Stop().

func (*HTTPServer) Listener

func (h *HTTPServer) Listener() net.Listener

Listener returns the listener for this server or nil if the server isn't yet listening.

func (*HTTPServer) Shutdown

func (h *HTTPServer) Shutdown(ctx context.Context) error

Shutdown stops the server. An error is returned if the server stopped unexpectedly.

Once a server is stopped, it cannot be started again with ListenAndServe.