http

Documentation

Index

• type Opts
• type Server
  • func NewServer(opts Opts) (Server, error)
  • func NewServerGroup(servers ...Server) Server

Types

type Opts

type Opts struct {
	// Handler is the http.Handler to be used to serve http pages by the server.
	Handler http.Handler

	// BindAddress is the address the HTTP server should listen on.
	BindAddress string

	// SecureBindAddress is the address the HTTPS server should listen on.
	SecureBindAddress string

	// TLS is the TLS configuration for the server.
	TLS *options.TLS
}

Opts contains the information required to set up the server.

type Server

type Server interface {
	// Start blocks and runs the server.
	Start(ctx context.Context) error
}

Server represents an HTTP or HTTPS server.

func NewServer

func NewServer(opts Opts) (Server, error)

NewServer creates a new Server from the options given.

func NewServerGroup

func NewServerGroup(servers ...Server) Server

NewServerGroup creates a new Server to start and gracefully stop a collection of Servers.