svr

Documentation

Overview

Package svr contains generic server startup/shutdown code, currently for running HTTP servers, but can also add in GRPC etc down the line.

Index

• type Options
• type Server
  • func New(log *zap.Logger) (Server, error)
• type TLSOptions
  • func (opts *TLSOptions) Copy() *TLSOptions

Types

type Options

type Options struct {
	Logger        *zap.Logger
	RequestLogger *zap.Logger
}

Options are options to a server.

type Server

type Server interface {
	AddHTTPEndpoint(name string, _ netx.HostPort, _ http.Handler, _ *TLSOptions) Server
	EndpointURL(name string) string
	Start(_ context.Context) error
	Stop(_ context.Context) error
	Run(_ context.Context) error
	WaitForShutdown(_ context.Context) error
}

A Server is a server mainline.

func New

func New(log *zap.Logger) (Server, error)

New creates a new server.

type TLSOptions

type TLSOptions struct {
	Config   *tls.Config
	CertFile string
	KeyFile  string
}

TLSOptions are options for transport layer security.

func (*TLSOptions) Copy

func (opts *TLSOptions) Copy() *TLSOptions

Copy creates a copy of the TLSOptions.