server

Documentation

Index

• type API
  • func NewAPI(handler APIHandler) (api *API)
• type APIHandler
• type File
  • func NewFile(handler FileHandler) (file *File)
• type FileHandler
• type ForwardProxy
  • func NewForwardProxy() (forwardProxy *ForwardProxy)
• type Proxy
  • func NewProxy(handler ProxyHandler) (proxy *Proxy)
• type ProxyHandler
• type ReverseProxy
  • func NewReverseProxy(originURL *url.URL) (reverseProxy *ReverseProxy, err error)
  • func (reverseProxy *ReverseProxy) SetOriginURL(originURL *url.URL)
• type Router
  • func NewRouter() (router *Router)
  • func (router *Router) NewRoute(route alox.Server, filters ...alox.Filter)
• type SPA
  • func NewSPA(handler SPAHandler, params SPAParams) (spa *SPA, err error)
  • func (spa *SPA) MustWriteFile(responseWriter http.ResponseWriter, request *http.Request)
  • func (spa *SPA) MustWriteWebpage(responseWriter http.ResponseWriter, request *http.Request)
  • func (spa *SPA) Webpage() *webpage.Webpage
  • func (spa *SPA) WriteFile(responseWriter http.ResponseWriter, request *http.Request) (err error)
  • func (spa *SPA) WriteFileOrWebpage(responseWriter http.ResponseWriter, request *http.Request)
  • func (spa *SPA) WriteWebpage(responseWriter http.ResponseWriter, request *http.Request) (err error)
• type SPAHandler
• type SPAParams
• type Server
  • func NewServer() *Server
  • func (server *Server) AddFilters(filter ...alox.Filter) alox.Server
  • func (server *Server) AddMiddlewares(middlewares ...alox.Middleware) alox.Server
  • func (server *Server) ContextValues() alox.ContextValues
  • func (server *Server) HandleError(responseWriter http.ResponseWriter, request *http.Request, err interface{})
  • func (server *Server) MarshalAndWriteJSON(responseWriter http.ResponseWriter, request *http.Request, value interface{})
  • func (server *Server) Match(request *http.Request) bool
  • func (server *Server) MustWriteWebpage(responseWriter http.ResponseWriter, request *http.Request, ...)
  • func (server *Server) NewAPI(handler APIHandler) (api *API)
  • func (server *Server) NewFile(handler FileHandler) (file *File)
  • func (server *Server) NewReverseProxy(originURL *url.URL) (reverseProxy *ReverseProxy, err error)
  • func (server *Server) NewSPA(handler SPAHandler, params SPAParams) (spa *SPA, err error)
  • func (server *Server) NewWeb(handler WebHandler) (web *Web)
  • func (server *Server) OnWrite(onWrite alox.OnWrite)
  • func (server *Server) RenderAndWriteHTMLNode(responseWriter http.ResponseWriter, request *http.Request, node *html.Node)
  • func (server *Server) ServeHTTP(responseWriter http.ResponseWriter, request *http.Request)
  • func (server *Server) SetErrorHandler(errorHandler alox.ErrorHandler) alox.Server
  • func (server *Server) SetHandler(handler alox.Handler) alox.Server
  • func (server *Server) Sub(sub alox.Server) alox.Server
  • func (server *Server) Write(responseWriter http.ResponseWriter, request *http.Request, contentType string, ...)
  • func (server *Server) WriteHTML(responseWriter http.ResponseWriter, request *http.Request, html []byte)
  • func (server *Server) WriteJSON(responseWriter http.ResponseWriter, request *http.Request, json []byte)
  • func (server *Server) WriteText(responseWriter http.ResponseWriter, request *http.Request, text []byte)
  • func (server *Server) WriteWebpage(responseWriter http.ResponseWriter, request *http.Request, ...) (err error)
  • func (server *Server) WriteXML(responseWriter http.ResponseWriter, request *http.Request, xml []byte)
• type Web
  • func NewWeb(handler WebHandler) (web *Web)
  • func (web *Web) SetWebpage(key string, webpage *webpage.Webpage) *Web
  • func (web *Web) Webpage(key string) *webpage.Webpage
  • func (web *Web) WriteFile(responseWriter http.ResponseWriter, request *http.Request, key, name string) (err error)
• type WebHandler

Types

type API

type API struct {
	*Server
}

func NewAPI

func NewAPI(handler APIHandler) (api *API)

type APIHandler

type APIHandler func(*API, http.ResponseWriter, *http.Request)

type File

type File struct {
	*Server
}

func NewFile

func NewFile(handler FileHandler) (file *File)

type FileHandler

type FileHandler func(*File, http.ResponseWriter, *http.Request)

type ForwardProxy

type ForwardProxy struct {
	*Proxy
}

func NewForwardProxy

func NewForwardProxy() (forwardProxy *ForwardProxy)

type Proxy

type Proxy struct {
	*Server
}

func NewProxy

func NewProxy(handler ProxyHandler) (proxy *Proxy)

type ProxyHandler

type ProxyHandler func(*Proxy, http.ResponseWriter, *http.Request)

type ReverseProxy

type ReverseProxy struct {
	*Proxy
	*httputil.ReverseProxy
	OriginURL *url.URL
}

func NewReverseProxy

func NewReverseProxy(originURL *url.URL) (reverseProxy *ReverseProxy, err error)

func (*ReverseProxy) SetOriginURL

func (reverseProxy *ReverseProxy) SetOriginURL(originURL *url.URL)

type Router

type Router struct {
	*Server
}

func NewRouter

func NewRouter() (router *Router)

func (*Router) NewRoute

func (router *Router) NewRoute(route alox.Server, filters ...alox.Filter)

type SPA

type SPA struct {
	*Web
	SPAParams
}

func NewSPA

func NewSPA(handler SPAHandler, params SPAParams) (spa *SPA, err error)

func (*SPA) MustWriteFile

func (spa *SPA) MustWriteFile(responseWriter http.ResponseWriter, request *http.Request)

func (*SPA) MustWriteWebpage

func (spa *SPA) MustWriteWebpage(responseWriter http.ResponseWriter, request *http.Request)

func (*SPA) Webpage

func (spa *SPA) Webpage() *webpage.Webpage

func (*SPA) WriteFile

func (spa *SPA) WriteFile(responseWriter http.ResponseWriter, request *http.Request) (err error)

func (*SPA) WriteFileOrWebpage

func (spa *SPA) WriteFileOrWebpage(responseWriter http.ResponseWriter, request *http.Request)

func (*SPA) WriteWebpage

func (spa *SPA) WriteWebpage(responseWriter http.ResponseWriter, request *http.Request) (err error)

type SPAHandler

type SPAHandler func(*SPA, http.ResponseWriter, *http.Request)

type SPAParams

type SPAParams struct {
	FS             fs.FS
	FSKey          string
	InputHTMLName  string
	HydrateWebpage func(*SPA, http.ResponseWriter, *http.Request, *webpage.Webpage)
}

type Server

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

func NewServer

func NewServer() *Server

func (*Server) AddFilters

func (server *Server) AddFilters(filter ...alox.Filter) alox.Server

func (*Server) AddMiddlewares

func (server *Server) AddMiddlewares(middlewares ...alox.Middleware) alox.Server

func (*Server) ContextValues

func (server *Server) ContextValues() alox.ContextValues

func (*Server) HandleError

func (server *Server) HandleError(responseWriter http.ResponseWriter, request *http.Request, err interface{})

func (*Server) MarshalAndWriteJSON

func (server *Server) MarshalAndWriteJSON(responseWriter http.ResponseWriter, request *http.Request, value interface{})

func (*Server) Match

func (server *Server) Match(request *http.Request) bool

func (*Server) MustWriteWebpage

func (server *Server) MustWriteWebpage(responseWriter http.ResponseWriter, request *http.Request, webpage *webpage.Webpage)

func (*Server) NewAPI

func (server *Server) NewAPI(handler APIHandler) (api *API)

func (*Server) NewFile

func (server *Server) NewFile(handler FileHandler) (file *File)

func (*Server) NewReverseProxy

func (server *Server) NewReverseProxy(originURL *url.URL) (reverseProxy *ReverseProxy, err error)

func (*Server) NewSPA

func (server *Server) NewSPA(handler SPAHandler, params SPAParams) (spa *SPA, err error)

func (*Server) NewWeb

func (server *Server) NewWeb(handler WebHandler) (web *Web)

func (*Server) OnWrite

func (server *Server) OnWrite(onWrite alox.OnWrite)

func (*Server) RenderAndWriteHTMLNode

func (server *Server) RenderAndWriteHTMLNode(responseWriter http.ResponseWriter, request *http.Request, node *html.Node)

func (*Server) ServeHTTP

func (server *Server) ServeHTTP(responseWriter http.ResponseWriter, request *http.Request)

func (*Server) SetErrorHandler

func (server *Server) SetErrorHandler(errorHandler alox.ErrorHandler) alox.Server

func (*Server) SetHandler

func (server *Server) SetHandler(handler alox.Handler) alox.Server

func (*Server) Sub

func (server *Server) Sub(sub alox.Server) alox.Server

func (*Server) Write

func (server *Server) Write(
	responseWriter http.ResponseWriter,
	request *http.Request,
	contentType string,
	contentLength int,
	data []byte,
)

func (*Server) WriteHTML

func (server *Server) WriteHTML(responseWriter http.ResponseWriter, request *http.Request, html []byte)

func (*Server) WriteJSON

func (server *Server) WriteJSON(responseWriter http.ResponseWriter, request *http.Request, json []byte)

func (*Server) WriteText

func (server *Server) WriteText(responseWriter http.ResponseWriter, request *http.Request, text []byte)

func (*Server) WriteWebpage

func (server *Server) WriteWebpage(responseWriter http.ResponseWriter, request *http.Request, webpage *webpage.Webpage) (err error)

func (*Server) WriteXML

func (server *Server) WriteXML(responseWriter http.ResponseWriter, request *http.Request, xml []byte)

type Web

type Web struct {
	*Server
	// https://hackandsla.sh/posts/2021-11-06-serve-spa-from-go/
	// use http.FileSystem instead?
	FS       map[string]fs.FS
	Webpages map[string]*webpage.Webpage
}

func NewWeb

func NewWeb(handler WebHandler) (web *Web)

func (*Web) SetWebpage

func (web *Web) SetWebpage(key string, webpage *webpage.Webpage) *Web

func (*Web) Webpage

func (web *Web) Webpage(key string) *webpage.Webpage

func (*Web) WriteFile

func (web *Web) WriteFile(responseWriter http.ResponseWriter, request *http.Request, key, name string) (err error)

type WebHandler

type WebHandler func(*Web, http.ResponseWriter, *http.Request)