package
0.74.0
Repository: https://github.com/beatlabs/patron.git
Documentation: pkg.go.dev

# Packages

Package auth provides abstractions for concrete implementations.
Package cache provides a cache control and implementation components for http routes.
No description provided by the author
No description provided by the author

# Functions

LivenessCheckRoute returns a route for liveness checks.
LoggingRoutes returns a routes relates to logs.
New creates an HTTP component configurable by functional options.
NewRoute creates a new raw route with functional configuration.
No description provided by the author
ReadyCheckRoute returns a route for ready checks.
WithAuth option for setting the route auth.
WithCache option for setting the route cache.
WithHandlerTimeout functional option.
WithMiddlewares option for setting the route optionFuncs.
WithPort functional option.
WithRateLimiting option for setting a route rate limiter.
WithReadTimeout functional option.
WithShutdownGracePeriod functional option.
WithTLS functional option.
WithWriteTimeout functional option.

# Constants

Alive represents a state defining an Alive state.
AlivePath of the component.
NotReady represents a state defining a NotReady state.
Ready represents a state defining a Ready state.
ReadyPath of the component.
Unhealthy represents an unhealthy alive state.

# Structs

Component implementation of an HTTP router.
Route definition of an HTTP route.
Routes definition.

# Type aliases

AliveStatus type representing the liveness of the service via HTTP component.
LivenessCheckFunc defines a function type for implementing a liveness check.
OptionFunc definition for configuring the component in a functional way.
ReadyCheckFunc defines a function type for implementing a readiness check.
ReadyStatus type.
RouteOptionFunc definition for configuring the route in a functional way.