web

Documentation

Index

• type Server
  • func New(b *broker.Broker, explainClient *explain.Client) *Server
  • func (s *Server) Handler() http.Handler
  • func (s *Server) Serve(lis net.Listener) error
  • func (s *Server) Shutdown(ctx context.Context) error

Types

type Server

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

Server serves the sql-tap web UI and API endpoints.

func New

func New(b *broker.Broker, explainClient *explain.Client) *Server

New creates a new web Server backed by the given Broker. explainClient may be nil if EXPLAIN is not configured.

func (*Server) Handler

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

Handler returns the HTTP handler for testing.

func (*Server) Serve

func (s *Server) Serve(lis net.Listener) error

Serve starts the HTTP server on the given listener.

func (*Server) Shutdown

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

Shutdown gracefully stops the HTTP server.