server

Documentation

Index

• type Config
• type HTTPServer
  • func (s *HTTPServer) Close() error
  • func (s *HTTPServer) Serve() error
• type Server
  • func New(cfg *Config) *Server
  • func (s *Server) Accept(addr string, listeners ...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 Config

type Config struct {
	CorsHeaders string
	Version     string
	SocketGroup string
	TLSConfig   *tls.Config
	// Hosts is a list of addresses for the API to listen on.
	Hosts []string
}

Config provides the configuration for the API server

type HTTPServer

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

HTTPServer contains an instance of http server and the listener. srv *http.Server, contains configuration to create an http server and a mux router with all api end points. l net.Listener, is a TCP or Socket listener that dispatches incoming request to the router.

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 {
	// contains filtered or unexported fields
}

Server contains instance details for the server

func New

func New(cfg *Config) *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, listeners ...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. This method also enables the Go profiler.

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 exits. It sends an error message if there is any error during the API execution.