webservice

Documentation

Index

• type Server
  • func NewServer(serviceIdentifier string, config ServerConfig, handler http.Handler) (*Server, error)
  • func (srv *Server) Serve(_ context.Context) error
  • func (srv *Server) ServiceInfo() service.Info
  • func (srv *Server) ServiceStatus() service.Status
  • func (srv *Server) ShutdownService(ctx context.Context) error
• type ServerConfig

Types

type Server

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

Server is a wrapper for http.Server.

func NewServer

func NewServer(
	serviceIdentifier string,
	config ServerConfig,
	handler http.Handler,
) (*Server, error)

func (*Server) Serve

func (srv *Server) Serve(_ context.Context) error

func (*Server) ServiceInfo

func (srv *Server) ServiceInfo() service.Info

func (*Server) ServiceStatus

func (srv *Server) ServiceStatus() service.Status

func (*Server) ShutdownService

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

type ServerConfig

type ServerConfig struct {
	ServePort int `env:"SERVE_PORT"`

	// ServiceInfo is used to override server's service info.
	ServiceInfo *service.Info `env:"-"`

	// Logger is used to pass the logger to the server instance.
	Logger *slog.Logger `env:"-"`
}