server

Documentation

Index

• type Options
• type Server
  • func NewServer(opts Options) *Server
  • func (s *Server) ServeUntilShutdown()
  • func (s *Server) Shutdown() error
  • func (s *Server) Start() error

Types

type Options

type Options struct {
	Address         string
	ProxyService    *proxy.ProxyService
	StopWaitSeconds int
}

Options holds basic web server settings.

type Server

type Server struct {
	monitor.ModuleLogger

	DefaultHeaders map[string]string
	Environment    *environment.Env
	ProxyService   *proxy.ProxyService
	// contains filtered or unexported fields
}

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

func NewServer

func NewServer(opts Options) *Server

NewServer returns a server initialized with settings from supplied options.

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.