server

Documentation

Index

• type Addr
• type Config
• type HTTPServer
  • func (s *HTTPServer) Close() error
  • func (s *HTTPServer) Serve() error
• type Server
  • func New(cfg *Config) (*Server, error)
  • func (s *Server) Close()
  • func (s *Server) CreateMux() *mux.Router
  • func (s *Server) InitRouters(d *daemon.Daemon)
  • func (s *Server) ServeAPI() error

Types

type Addr

type Addr struct {
	Proto string
	Addr  string
}

Addr contains string representation of address and its protocol (tcp, unix...).

type Config

type Config struct {
	Logging     bool
	EnableCors  bool
	CorsHeaders string
	Version     string
	SocketGroup string
	TLSConfig   *tls.Config
	Addrs       []Addr
}

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 a 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, error)

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) Close

func (s *Server) Close()

Close closes servers and thus stop receiving requests

func (*Server) CreateMux

func (s *Server) CreateMux() *mux.Router

CreateMux initializes the main router the server uses. we keep enableCors just for legacy usage, need to be removed in the future

func (*Server) InitRouters

func (s *Server) InitRouters(d *daemon.Daemon)

InitRouters initializes a list of routers for the server.

func (*Server) ServeAPI

func (s *Server) ServeAPI() error

ServeAPI loops through all initialized servers and spawns goroutine with Server method for each. It sets CreateMux() as Handler also.