server

Documentation

Index

• func GetRandPort() uint16
• type Server
  • func New(banner bool, logger *log.Logger) *Server
  • func (s *Server) RegisterController(ctrl controllers.Controller)
  • func (s *Server) Run(port uint16) error
  • func (s *Server) Shutdown()

Functions

func GetRandPort

func GetRandPort() uint16

GetRandPort generates a random port number from 1024 to 65535.

Types

type Server

type Server struct {
	Running bool
	// contains filtered or unexported fields
}

Server is the http server implementation using 'echo' framework. It is central object for RESTful APIs in this app.

func New

func New(banner bool, logger *log.Logger) *Server

New creates a new instance of http server.

func (*Server) RegisterController

func (s *Server) RegisterController(ctrl controllers.Controller)

RegisterController adds the specified controller and its routes in the server runtime environment.

func (*Server) Run

func (s *Server) Run(port uint16) error

Run starts the http server and returns the error object for any failure.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown stops the http server gracefully and resets the server state.