server

Documentation

Overview

Package server just encapsulates the HTTP server that serves the API

Index

• type Server
  • func New(cfg config.Config, logger *zap.Logger) *Server
  • func (s *Server) AddHandler(path string, handler http.Handler)
  • func (s *Server) Address() *net.TCPAddr
  • func (s *Server) Serve()
  • func (s *Server) Stop()
  • func (s *Server) WaitUntilReady()

Types

type Server

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

Server handles serving the core API for Aetherometer

func New

func New(
	cfg config.Config,
	logger *zap.Logger,
) *Server

New initializes a new instance of the core server

func (*Server) AddHandler

func (s *Server) AddHandler(path string, handler http.Handler)

AddHandler adds a handler to this server

func (*Server) Address

func (s *Server) Address() *net.TCPAddr

Address returns the address of this server. This value is only valid if the server has been started, otherwise it'll be a nil Addr interface value.

func (*Server) Serve

func (s *Server) Serve()

Serve is responsible for running the core server

func (*Server) Stop

func (s *Server) Stop()

Stop will shutdown the core server, and will timeout within 1 second

func (*Server) WaitUntilReady

func (s *Server) WaitUntilReady()

WaitUntilReady blocks until the server has started listening