server

Documentation

Index

• type HTTPServer
  • func (s *HTTPServer) Close() error
  • func (s *HTTPServer) Serve() error
• type Server
  • func New(contextRoot string) *Server
  • func (s *Server) Accept(addr string, listener net.Listener)
  • func (s *Server) Close()
  • func (s *Server) InitRouter(routers ...router.Router)
  • func (s *Server) UseMiddleware(m middleware.Middleware)
  • func (s *Server) Wait(waitChan chan error)

Types

type HTTPServer

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

HTTPServer contains an instance of http server and the listener.

func (*HTTPServer) Close

func (s *HTTPServer) Close() error

Close closes the HTTPServer from listening for the inbound requests.

func (*HTTPServer) Serve

func (s *HTTPServer) Serve() error

Serve starts listening for inbound requests.

type Server

type Server struct {
	Mux *mux.Router
	// contains filtered or unexported fields
}

Server contains instance details for the server

func New

func New(contextRoot string) *Server

New returns a new instance of the server based on the specified configuration. It allocates resources which will be needed for ServeAPI(ports, unix-sockets).

func (*Server) Accept

func (s *Server) Accept(addr string, listener net.Listener)

Accept sets a listener the server accepts connections into.

func (*Server) Close

func (s *Server) Close()

Close closes servers and thus stop receiving requests

func (*Server) InitRouter

func (s *Server) InitRouter(routers ...router.Router)

InitRouter initializes the list of routers for the server.

func (*Server) UseMiddleware

func (s *Server) UseMiddleware(m middleware.Middleware)

UseMiddleware appends a new middleware to the request chain. This needs to be called before the API routes are configured.

func (*Server) Wait

func (s *Server) Wait(waitChan chan error)

Wait blocks the server goroutine until it exists. It sends an error message if there is any error during the API execution.