webs

Documentation

Index

• func RequestName(r *http.Request) string
• func RequestNameX(r *http.Request, xRemoteAddress string) string
• func RouteName(method, uri string) string
• func WebSocketName(name string) string
• type DualServer
  • func NewDual() *DualServer
  • func (o *DualServer) Run(addr string, addrTls string, handler http.Handler) error
  • func (o *DualServer) Shutdown()
  • func (o *DualServer) WithAutoSecret(dir string, domains ...string) *DualServer
  • func (o *DualServer) WithLogErrors(use bool) *DualServer
  • func (o *DualServer) WithLogErrorsLevel(level ulog.Level) *DualServer
  • func (o *DualServer) WithLogRequests(use bool) *DualServer
  • func (o *DualServer) WithRedirectToTls(use string) *DualServer
  • func (o *DualServer) WithSecret(certFile, keyFile string) *DualServer
  • func (o *DualServer) WithSecretDir(dir string) *DualServer
  • func (o *DualServer) WithXRemoteAddress(s string) *DualServer
• type OnRequest
• type OnWebsocket
• type Router
  • func NewRouter() *Router
  • func (o Router) Branch(path string) *Router
  • func (o *Router) Delete(path string, onRequest OnRequest)
  • func (o *Router) Files(files fs.FS)
  • func (o *Router) Get(path string, onRequest OnRequest)
  • func (o *Router) Handle(method string, path string, onRequest OnRequest)
  • func (o *Router) IsRoot() bool
  • func (o *Router) Log() *ulog.Log
  • func (o *Router) Options(path string, onRequest OnRequest)
  • func (o *Router) Post(path string, onRequest OnRequest)
  • func (o *Router) Put(path string, onRequest OnRequest)
  • func (o *Router) Router() *mux.Router
  • func (o *Router) WebSocket(path string, onWebsocket OnWebsocket)
  • func (o *Router) WithID(id any) *Router
  • func (o *Router) WithLogRequest(logRequest bool) *Router
  • func (o *Router) WithUpgradeErrorLevel(level ulog.Level) *Router
  • func (o *Router) WithXRemoteAddress(s string) *Router
• type Server
  • func New() *Server
  • func (o *Server) IsTls() bool
  • func (o *Server) LogRequest(mux http.Handler) http.Handler
  • func (o *Server) Run(addr string, handler http.Handler)
  • func (o *Server) Shutdown()
  • func (o *Server) WithAutoSecret(dir string, domains ...string) *Server
  • func (o *Server) WithLogErrors(use bool) *Server
  • func (o *Server) WithLogErrorsLevel(level ulog.Level) *Server
  • func (o *Server) WithLogRequests(use bool) *Server
  • func (o *Server) WithSecret(certFile, keyFile string) *Server
  • func (o *Server) WithSecretDir(dir string) *Server
  • func (o *Server) WithXRemoteAddress(s string) *Server

Functions

func RequestName

func RequestName(r *http.Request) string

func RequestNameX

func RequestNameX(r *http.Request, xRemoteAddress string) string

func RouteName

func RouteName(method, uri string) string

func WebSocketName

func WebSocketName(name string) string

Types

type DualServer

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

func NewDual

func NewDual() *DualServer

func (*DualServer) Run

func (o *DualServer) Run(addr string, addrTls string, handler http.Handler) error

func (*DualServer) Shutdown

func (o *DualServer) Shutdown()

func (*DualServer) WithAutoSecret

func (o *DualServer) WithAutoSecret(dir string, domains ...string) *DualServer

func (*DualServer) WithLogErrors

func (o *DualServer) WithLogErrors(use bool) *DualServer

func (*DualServer) WithLogErrorsLevel

func (o *DualServer) WithLogErrorsLevel(level ulog.Level) *DualServer

func (*DualServer) WithLogRequests

func (o *DualServer) WithLogRequests(use bool) *DualServer

func (*DualServer) WithRedirectToTls

func (o *DualServer) WithRedirectToTls(use string) *DualServer

func (*DualServer) WithSecret

func (o *DualServer) WithSecret(certFile, keyFile string) *DualServer

func (*DualServer) WithSecretDir

func (o *DualServer) WithSecretDir(dir string) *DualServer

func (*DualServer) WithXRemoteAddress

func (o *DualServer) WithXRemoteAddress(s string) *DualServer

type OnRequest

type OnRequest func(http.ResponseWriter, *http.Request)

type OnWebsocket

type OnWebsocket func(*websocket.Conn)

type Router

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

func NewRouter

func NewRouter() *Router

func (Router) Branch

func (o Router) Branch(path string) *Router

func (*Router) Delete

func (o *Router) Delete(path string, onRequest OnRequest)

func (*Router) Files

func (o *Router) Files(files fs.FS)

func (*Router) Get

func (o *Router) Get(path string, onRequest OnRequest)

func (*Router) Handle

func (o *Router) Handle(method string, path string, onRequest OnRequest)

func (*Router) IsRoot

func (o *Router) IsRoot() bool

func (*Router) Log

func (o *Router) Log() *ulog.Log

func (*Router) Options

func (o *Router) Options(path string, onRequest OnRequest)

func (*Router) Post

func (o *Router) Post(path string, onRequest OnRequest)

func (*Router) Put

func (o *Router) Put(path string, onRequest OnRequest)

func (*Router) Router

func (o *Router) Router() *mux.Router

func (*Router) WebSocket

func (o *Router) WebSocket(path string, onWebsocket OnWebsocket)

func (*Router) WithID

func (o *Router) WithID(id any) *Router

func (*Router) WithLogRequest

func (o *Router) WithLogRequest(logRequest bool) *Router

func (*Router) WithUpgradeErrorLevel

func (o *Router) WithUpgradeErrorLevel(level ulog.Level) *Router

func (*Router) WithXRemoteAddress

func (o *Router) WithXRemoteAddress(s string) *Router

type Server

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

func New

func New() *Server

func (*Server) IsTls

func (o *Server) IsTls() bool

func (*Server) LogRequest

func (o *Server) LogRequest(mux http.Handler) http.Handler

func (*Server) Run

func (o *Server) Run(addr string, handler http.Handler)

func (*Server) Shutdown

func (o *Server) Shutdown()

func (*Server) WithAutoSecret

func (o *Server) WithAutoSecret(dir string, domains ...string) *Server

func (*Server) WithLogErrors

func (o *Server) WithLogErrors(use bool) *Server

func (*Server) WithLogErrorsLevel

func (o *Server) WithLogErrorsLevel(level ulog.Level) *Server

func (*Server) WithLogRequests

func (o *Server) WithLogRequests(use bool) *Server

func (*Server) WithSecret

func (o *Server) WithSecret(certFile, keyFile string) *Server

func (*Server) WithSecretDir

func (o *Server) WithSecretDir(dir string) *Server

func (*Server) WithXRemoteAddress

func (o *Server) WithXRemoteAddress(s string) *Server