httpserver

package
v0.0.0-...-7cafca0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2024 License: AGPL-3.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ExtraHandler

type ExtraHandler struct {
	Path        string
	HandlerFunc http.HandlerFunc
	HTTPMethods []string
}

ExtraHandler ... add extra endpoints to listen on

type WebServer

type WebServer struct {
	AppPort               string
	HTTPAllowedOrigins    []string
	Error404FilePath      string
	ExtraHandlers         []*ExtraHandler
	ExtraMiddleware       []func(http.Handler) http.Handler
	GzipEnabled           bool
	HTTPPort              string
	HTTPSPort             string
	HTTPSPortEnabled      bool
	HeaderMap             map[string][]string
	HeaderMapEnabled      bool
	HeaderMapPath         string
	HealthPort            string
	HealthPortEnabled     bool
	UseInMemoryServePath  bool
	MetricsPort           string
	MetricsPortEnabled    bool
	RealIPHeader          string
	RedirectRoutes        map[string]string
	RedirectRoutesEnabled bool
	RedirectRoutesPath    string
	RewriteDomains        map[string]string
	ServeFolder           string
	TLSCertPath           string
	TLSConfig             *tls.Config
	TLSKeyPath            string
	TemplateMap           map[string]string
	TemplateMapEnabled    bool
	TemplateMapPath       string
	VueJSHistoryMode      bool
	// contains filtered or unexported fields
}

WebServer configures the runtime

func NewWebServer

func NewWebServer() *WebServer

NewWebServer returns a default WebServer, as per environment configuration

TODO clean up function

func (*WebServer) Listen

func (w *WebServer) Listen(ch ...<-chan bool)

Listen starting listening according to the configuration

func (*WebServer) LoadHeaderMap

func (w *WebServer) LoadHeaderMap() (*WebServer, error)

LoadHeaderMap loads the header map from the path

func (*WebServer) LoadTLS

func (w *WebServer) LoadTLS() (*WebServer, error)

LoadTLS loads in the TLS certs

func (*WebServer) LoadTemplateMap

func (w *WebServer) LoadTemplateMap() (*WebServer, error)

LoadTemplateMap loads the template map from the path

func (*WebServer) NewMetricsFromWebServer

func (w *WebServer) NewMetricsFromWebServer() *metrics.Metrics

NewMetricsFromWebServer returns a new metrics from a webserver

func (*WebServer) SetExtraHandlers

func (w *WebServer) SetExtraHandlers(hs ...*ExtraHandler) *WebServer

SetExtraHandlers sets extra http handlers

func (*WebServer) SetExtraMiddleware

func (w *WebServer) SetExtraMiddleware(m ...func(http.Handler) http.Handler) *WebServer

SetExtraMiddleware sets extra http middleware

func (*WebServer) SetHandler

func (w *WebServer) SetHandler(input *handlers.Handler) *WebServer

SetHandler sets a new handler

func (*WebServer) SetHeaderMap

func (w *WebServer) SetHeaderMap(input map[string][]string) *WebServer

SetHeaderMap sets the header map

func (*WebServer) SetServeFolder

func (w *WebServer) SetServeFolder(path string) *WebServer

SetServeFolder sets the path to the ServeFolder

func (*WebServer) SetTemplateMap

func (w *WebServer) SetTemplateMap(input map[string]string) *WebServer

SetTemplateMap set the template map

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL