Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v1.9.0
type Config struct {
Logging bool
EnableCors bool
CorsHeaders string
AuthorizationPluginNames []string
Version string
SocketGroup string
TLSConfig *tls.Config
}
Config provides the configuration for the API server
type HTTPServer ¶ added in v1.9.0
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 ¶ added in v1.9.0
func (s *HTTPServer) Close() error
Close closes the HTTPServer from listening for the inbound requests.
func (*HTTPServer) Serve ¶ added in v1.9.0
func (s *HTTPServer) Serve() error
Serve starts listening for inbound requests.
type Server ¶ added in v1.4.0
type Server struct {
// contains filtered or unexported fields
}
Server contains instance details for the server
func New ¶ added in v1.7.0
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 ¶ added in v1.11.0
Accept sets a listener the server accepts connections into.
func (*Server) Close ¶ added in v1.4.0
func (s *Server) Close()
Close closes servers and thus stop receiving requests
func (*Server) DisableProfiler ¶ added in v1.11.0
func (s *Server) DisableProfiler()
DisableProfiler reloads the server mux without adding the profiler routes.
func (*Server) EnableProfiler ¶ added in v1.11.0
func (s *Server) EnableProfiler()
EnableProfiler reloads the server mux adding the profiler routes.
func (*Server) InitRouter ¶ added in v1.11.0
InitRouter initializes the list of routers for the server. This method also enables the Go profiler if enableProfiler is true.
Source Files
Directories