server

package

v0.0.0-...-a677d05 Latest Latest Go to latest Published: Oct 1, 2024 License: BSD-3-Clause Imports: 10 Imported by: 0

Details

Package server provides a generic server implementation which is used by the different applications to serve their endpoints.

View Source

const (
	BuildInfoRoute   = buildinfo.MetricName
	HealthCheckRoute = "healthcheck"
	FaviconRoute     = "favicon"
)

This section is empty.

This section is empty.

type Config struct {
	Port      serv.Port `default:"2512"`
	AccessLog bool      `default:"true"`
	TLS       easytls.Config
}

func (c Config) Validate() error

type Logger interface {
	RegisterRouteLogger
	serv.Logger
	accesslog.Logger
}

type Option func(app *Server, conf Config) error

func WithBuildInfo(bld *buildinfo.BuildInfo) Option

func WithHealthChecker(hc *healthcheck.Checker) Option

func WithNotFoundHandler(h http.Handler) Option

func WithRoutesRegisterer(r serv.RoutesRegisterer) Option

type RegisterRouteLogger interface {
	LogRegisterRoute(route serv.Route)
}

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

func New(name string, conf Config, log Logger, telem *telemetry.Telemetry, opts ...Option) (*Server, error)

func (srv *Server) Name() string

func (srv *Server) RouteHandler() serv.RouteHandler

func (srv *Server) Run(ctx context.Context) error

func (srv *Server) Shutdown(ctx context.Context) error