server

Documentation

Overview

Package server provides a basic HTTP server wrapper

Package server provides a basic HTTP server wrapper

Index

• type Group
  • func NewGroup(ctx context.Context, conf config.ServerConfig) *Group
  • func (g *Group) GoListenAndServe(name, port string, handler http.Handler)
  • func (g *Group) Wait() error
• type Server
  • func NewServer(name, port string, handler http.Handler, conf config.ServerConfig) (Server, error)
  • func (s Server) ListenAndServe() (err error)
  • func (s Server) Shutdown()

Types

type Group

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

Group encapsulates managing multiple Server instances

func NewGroup

func NewGroup(ctx context.Context, conf config.ServerConfig) *Group

NewGroup creares a new server group.

func (*Group) GoListenAndServe

func (g *Group) GoListenAndServe(name, port string, handler http.Handler)

GoListenAndServe constructs a NewServer and adds it to the Group. Two goroutines are started. One for the http listener and one to initiate a graceful shutdown. This method blocks on adding the go routines to maintain startup order of each listener.

func (*Group) Wait

func (g *Group) Wait() error

Wait waits for all servers to complete before returning

type Server

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

Server has generic functionality for service: it starts the service and performs basic checks

func NewServer

func NewServer(name, port string, handler http.Handler, conf config.ServerConfig) (Server, error)

NewServer initializes new service. Configuration is pulled from viper configuration.

func (Server) ListenAndServe

func (s Server) ListenAndServe() (err error)

ListenAndServe starts the server

func (Server) Shutdown

func (s Server) Shutdown()

Shutdown server gracefully