http

Documentation

Index

• type HTTPServer
  • func New(config server.Config, opts ...Option) (*HTTPServer, error)
  • func (s *HTTPServer) Handle(mux http.Handler)
  • func (s *HTTPServer) Serve(result chan<- error)
  • func (s *HTTPServer) Stop()
• type Option
  • func WithLogger(l log.Logger) Option
  • func WithTLS(cfg *tls.Config) Option
• type Server

Types

type HTTPServer

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

func New

func New(config server.Config, opts ...Option) (*HTTPServer, error)

New creates an HTTP server with a default handler and has not started to accept requests yet.

func (*HTTPServer) Handle

func (s *HTTPServer) Handle(mux http.Handler)

Handle associates the given handler with the server.

func (*HTTPServer) Serve

func (s *HTTPServer) Serve(result chan<- error)

Serve accepts incoming connections, creating a new service goroutine for each. The service goroutine reads requests and then call the handler to reply to them.

func (*HTTPServer) Stop

func (s *HTTPServer) Stop()

Stop shuts down the http server gracefully without interrupting an active connections.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option provides options for configuring the creation of a http server.

func WithLogger

func WithLogger(l log.Logger) Option

WithLogger will add logging to the http server.

func WithTLS

func WithTLS(cfg *tls.Config) Option

WithTLS will configure the server to require TLS.

type Server

type Server interface {
	server.Server            // Implements Serve and Stop
	Handle(mux http.Handler) // Handle the given mux.
}

Server is an HTTP server to serve HTTP requests.