Documentation
¶
Index ¶
- type App
- func (a App) CSP() *common.CSP
- func (a App) Drain(migrate bool, callback func())
- func (a App) InstanceCount() int
- func (a App) InstanceCreated()
- func (a App) InstanceDeleted()
- func (a App) Migrating() bool
- func (a App) PathMaker() path.PathMaker
- func (a App) RemoveSession(id string)
- func (a App) Resources() resources.Registry
- func (a App) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (a App) SessionCount() (n int)
- type ErrorPage
- type Middleware
- type Options
- type Page
- type SessionTracker
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App = *app
App is a Doors application and HTTP handler.
func (App) InstanceCount ¶ added in v0.12.8
func (App) InstanceCreated ¶ added in v0.13.6
func (a App) InstanceCreated()
func (App) InstanceDeleted ¶ added in v0.13.6
func (a App) InstanceDeleted()
func (App) RemoveSession ¶
func (App) SessionCount ¶ added in v0.12.8
type Middleware ¶
Middleware wraps the app handler.
type Options ¶
type Options struct {
// Conf is the runtime configuration from doors.WithConf.
Conf common.Conf
// CSP is the policy from doors.WithCSP. Nil sends no header.
CSP *common.CSP
// ESBuild is the esbuild options provider from doors.WithESProfiles.
ESBuild func(profile string) api.BuildOptions
// SessionTrackers are the observers from doors.WithSessionTracker, in
// registration order.
SessionTrackers []SessionTracker
// ID is the app id from doors.WithID. Default: doors.
ID string
// CookieName is the app id cookie name from doors.WithIDCookie. Empty
// sets no cookie.
CookieName string
// ErrorPage is the error renderer from doors.WithErrorPage.
ErrorPage ErrorPage
// Logger is the logger from doors.WithLogger. Nil uses slog.Default().
Logger *slog.Logger
// PrinterMiddleware is the printer wrapper from doors.WithPrinter. Nil
// disables wrapping.
PrinterMiddleware func(next gox.Printer) gox.Printer
// Values add the context values from doors.WithValue, in order.
Values []func(context.Context) context.Context
// Keys are the keys from doors.WithValue.
Keys []any
}
Options is the resolved set of app options.
type SessionTracker ¶
type SessionTracker interface {
// Create runs when a session is created, before the request that
// triggered it is served. r must not be retained past the call and its
// body must not be read.
Create(id string, r *http.Request)
// Delete runs at most once per session, when it is removed.
Delete(id string)
}
SessionTracker observes session creation and removal.
Click to show internal directories.
Click to hide internal directories.