server

Documentation

Index

• type Server
  • func New(settings Settings) *Server
  • func (a *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 creates new Server instance. It takes Settings as argument and returns pointer to Server. All fields of Settings are required and cant be nil.

func (*Server) Start

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

Start starts the server and blocks until context is canceled. It returns error if server cant be started. Server is gracefully stopped when context is canceled. If error occurs on start, shutdown is skipped.

type Settings

type Settings struct {
	Addr string
	Port string

	Handler http.Handler

	ShutdownMaxTime time.Duration
}

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