server

Documentation

Index

• type Server
  • func New(settings Settings) *Server
  • func (s *Server) Start(ctx context.Context) error
• type Settings

Types

type Server

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

Server is a http server. Can be started with Start method. Gracefully stops when context is canceled. Must be initialized with New function.

func New

func New(settings Settings) *Server

New initializes and returns a new Server instance based on the provided settings. It configures the server address and handler, and sets the shutdown timeout to a default value.

func (*Server) Start

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

Start starts the server. It returns an error if it fails to start the server. The error is not returned if the context is canceled, the server is shutdown and the shutdown is successful.

The server is shutdown when the context is canceled. The shutdown is cancelled if the server failed to start.

type Settings

type Settings struct {
	Addr    string
	Handler http.Handler
}

Settings used to create Server. Settings must be provided to New function. All fields are required and cant be nil.