httpserver

Documentation

Index

• Variables
• type HandleChainFunc
• type Logger
• type Server
  • func New(log Logger, name string, port string, h http.Handler, opts ...ServerOption) *Server
  • func (s *Server) Listen() error
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) String() string
• type ServerOption
  • func WithHandlers(handlers ...HandleChainFunc) ServerOption
  • func WithOptionalHandlers(handlers ...HandleChainFunc) ServerOption

Variables

var (
	ErrNilHandler            = errors.New("Nil Handler")
	ErrNilHandlerValue       = errors.New("Nil Handler value")
	ErrHandlerFuncReturnsNil = errors.New("Handler function returns nil")
)

Types

type HandleChainFunc

type HandleChainFunc func(http.Handler) http.Handler

type Logger

type Logger = logger.Logger

type Server

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

func New

func New(log Logger, name string, port string, h http.Handler, opts ...ServerOption) *Server

New creates a new httpserver.

func (*Server) Listen

func (s *Server) Listen() error

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

func (*Server) String

func (s *Server) String() string

type ServerOption

type ServerOption func(*Server)

func WithHandlers

func WithHandlers(handlers ...HandleChainFunc) ServerOption

WithHandlers adds a handler on the http endpoint. If the handler is nil then an error will occur when executing the Listen() method.

func WithOptionalHandlers

func WithOptionalHandlers(handlers ...HandleChainFunc) ServerOption

WithOptionalHandlers adds a handler on the http endpoint. If the handler is nil it is ignored.