server

Documentation

Index

• type Server
  • func NewServer() Server
  • func (s *Server) GracefulShutdown()
  • func (s *Server) Router() *mux.Router
  • func (s *Server) Start() chan bool

Types

type Server

type Server struct {
	Close chan os.Signal
	Wait  chan bool
	Error chan error
	// contains filtered or unexported fields
}

Server is a structured wrapper for running the API server, encapsulating a route and error handling

func NewServer

func NewServer() Server

NewServer returns a new Server with defaults set, routes bootstrapped, and middleware set up

func (*Server) GracefulShutdown

func (s *Server) GracefulShutdown()

GracefulShutdown safely shuts down the server

func (*Server) Router

func (s *Server) Router() *mux.Router

func (*Server) Start

func (s *Server) Start() chan bool

Start starts the http server