v2

Mar 18, 2022

Changes in this version

+ const Alive

+ const AlivePath

+ const MetricsPath

+ const NotReady

+ const Ready

+ const ReadyPath

+ const Unhealthy

+ type AliveStatus int

+ type Component struct

+ func New(handler http.Handler, oo ...OptionFunc) (*Component, error)

+ func (c *Component) Run(ctx context.Context) error

+ type LivenessCheckFunc func() AliveStatus

+ type OptionFunc func(*Component) error

+ func HandlerTimeout(wt time.Duration) OptionFunc

+ func Port(port int) OptionFunc

+ func ReadTimeout(rt time.Duration) OptionFunc

+ func ShutdownGracePeriod(gp time.Duration) OptionFunc

+ func TLS(cert, key string) OptionFunc

+ func WriteTimeout(wt time.Duration) OptionFunc

+ type ReadyCheckFunc func() ReadyStatus

+ type ReadyStatus int

+ type Route struct

+ func LivenessCheckRoute(acf LivenessCheckFunc) (*Route, error)

+ func MetricRoute() *Route

+ func NewConnectRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewDeleteRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewGetRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewHeadRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewOptionsRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewPatchRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewPostRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewPutRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewRoute(method, path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func NewTraceRoute(path string, handler http.HandlerFunc, oo ...RouteOptionFunc) (*Route, error)

+ func ProfilingRoutes(enableExpVar bool) []*Route

+ func ReadyCheckRoute(rcf ReadyCheckFunc) (*Route, error)

+ func (r Route) Handler() http.HandlerFunc

+ func (r Route) Method() string

+ func (r Route) Middlewares() []patronhttp.Func

+ func (r Route) Path() string

+ func (r Route) String() string

+ type RouteOptionFunc func(route *Route) error

+ func Auth(auth auth.Authenticator) RouteOptionFunc

+ func Cache(cache cache.TTLCache, ageBounds httpcache.Age) RouteOptionFunc

+ func Middlewares(mm ...patronhttp.Func) RouteOptionFunc

+ func RateLimiting(limit float64, burst int) RouteOptionFunc

+ type Routes struct

+ func (r *Routes) Append(route *Route, err error)

+ func (r *Routes) Result() ([]*Route, error)