server

Documentation

Index

• type Server
  • func New(authenticator *auth.Authenticator, log *logger.Logger, host, port string) *Server
  • func (s *Server) Addr() string
  • func (s *Server) IsRunning() bool
  • func (s *Server) Start() error
  • func (s *Server) Stop(ctx context.Context) error

Types

type Server

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

Server encapsulates the HTTP server lifecycle.

func New

func New(authenticator *auth.Authenticator, log *logger.Logger, host, port string) *Server

New creates a Server with routes and timeouts configured.

func (*Server) Addr

func (s *Server) Addr() string

Addr returns the listen address.

func (*Server) IsRunning

func (s *Server) IsRunning() bool

IsRunning returns whether the server is currently running.

func (*Server) Start

func (s *Server) Start() error

Start begins listening in a goroutine. It returns an error if the listener cannot be established.

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

Stop performs a graceful shutdown of the server.