http

Documentation

Index

• type Handler
  • func NewHandler(router http.Handler, opts ...HandlerOption) (*Handler, error)
  • func (h *Handler) Close() error
  • func (h *Handler) Serve() error
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandlerOption
  • func OptHandlerBind(b string) HandlerOption
  • func OptHandlerCloseTimeout(d time.Duration) HandlerOption
  • func OptHandlerComputer(handler http.Handler) HandlerOption
  • func OptHandlerController(c *controller.Controller) HandlerOption
  • func OptHandlerListener(ln net.Listener, url string) HandlerOption
  • func OptHandlerLogger(l logger.Logger) HandlerOption
  • func OptHandlerQueryer(q *queryer.Queryer) HandlerOption
  • func OptHandlerSnapshotter(s *snapshotter.Snapshotter) HandlerOption
  • func OptHandlerWritelogger(w *writelogger.Writelogger) HandlerOption

Types

type Handler

type Handler struct {
	Handler http.Handler
	// contains filtered or unexported fields
}

Handler represents an HTTP handler.

func NewHandler

func NewHandler(router http.Handler, opts ...HandlerOption) (*Handler, error)

NewHandler returns a new instance of Handler with a default logger.

func (*Handler) Close

func (h *Handler) Close() error

Close tries to cleanly shutdown the HTTP server, and failing that, after a timeout, calls Server.Close.

func (*Handler) Serve

func (h *Handler) Serve() error

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP handles an HTTP request.

type HandlerOption

type HandlerOption func(s *Handler) error

HandlerOption is a functional option type for Handler

func OptHandlerBind

func OptHandlerBind(b string) HandlerOption

func OptHandlerCloseTimeout

func OptHandlerCloseTimeout(d time.Duration) HandlerOption

OptHandlerCloseTimeout controls how long to wait for the http Server to shutdown cleanly before forcibly destroying it. Default is 30 seconds.

func OptHandlerComputer

func OptHandlerComputer(handler http.Handler) HandlerOption

func OptHandlerController

func OptHandlerController(c *controller.Controller) HandlerOption

func OptHandlerListener

func OptHandlerListener(ln net.Listener, url string) HandlerOption

OptHandlerListener set the listener that will be used by the HTTP server. Url must be the advertised URL. It will be used to show a log to the user about where the Web UI is. This option is mandatory.

func OptHandlerLogger

func OptHandlerLogger(l logger.Logger) HandlerOption

func OptHandlerQueryer

func OptHandlerQueryer(q *queryer.Queryer) HandlerOption

func OptHandlerSnapshotter

func OptHandlerSnapshotter(s *snapshotter.Snapshotter) HandlerOption

func OptHandlerWritelogger

func OptHandlerWritelogger(w *writelogger.Writelogger) HandlerOption