server

Documentation

Index

• func ServeUntilInterrupted()
• type Config
• type Server
  • func NewConfiguredServer() *Server
  • func (s *Server) ServeUntilShutdown()
  • func (s *Server) Shutdown() error
  • func (s *Server) Start() error

Functions

func ServeUntilInterrupted

func ServeUntilInterrupted()

ServeUntilInterrupted is the main module entry point that configures and starts a webserver, which runs until one of OS shutdown signals are received. The function is blocking.

Types

type Config

type Config struct {
	StaticDir string
	Address   string
}

Config holds basic web server settings

type Server

type Server struct {
	Config *Config
	Logger *log.Logger

	InterruptChan  chan os.Signal
	DefaultHeaders map[string]string
	// contains filtered or unexported fields
}

Server holds entities that can be used to control the web server

func NewConfiguredServer

func NewConfiguredServer() *Server

NewConfiguredServer returns a server initialized with settings from global config.

func (*Server) ServeUntilShutdown

func (s *Server) ServeUntilShutdown()

ServeUntilShutdown blocks until a shutdown signal is received, then shuts down the http server.

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown gracefully shuts down the peer server.

func (*Server) Start

func (s *Server) Start() error

Start starts a http server and returns immediately.