Documentation ¶
Overview ¶
Package http implements http interface for Stee. It is in charge of handling HTTP server(s) and handling of clients HTTP requests on them.
Index ¶
- func EnableAPI(enable bool, prefix string) handleRootOption
- func EnableSimpleAPI(enable bool) handleRootOption
- func EnableUI(enable bool, prefix string) handleRootOption
- func HandleRoot(core *stee.Core, options ...handleRootOption) http.Handler
- func NewServer(cfg ServerConfig) *http.Server
- type ServerConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnableAPI ¶
EnableAPI is an option for HandleRoot(). It enables the API.
It should only be used as an argument for HandleRoot(), hence the unexported return type.
func EnableSimpleAPI ¶
func EnableSimpleAPI(enable bool) handleRootOption
EnableSimpleAPI is an option for HandleRoot(). It enables the simple API.
It should only be used as an argument for HandleRoot(), hence the unexported return type.
func EnableUI ¶
EnableUI is an option for HandleRoot(). It enables the UI.
It should only be used as an argument for HandleRoot(), hence the unexported return type.
func HandleRoot ¶
HandleRoot returns a http.Handler in charge of dispatching requests to the appropriate "sub"-handler
Types ¶
type ServerConfig ¶
ServerConfig is the configuration to provide to create an http.Server with NewServer()