http

Documentation

Index

• func Response(ctx context.Context, w http.ResponseWriter, err error)
• type ResponseError
  • func (e ResponseError) Error() string
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) Register(services ...Service)
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown()
• type ServerOption
  • func WithMiddleware(mw ...mux.MiddlewareFunc) ServerOption
  • func WithServerAddr(addr string) ServerOption
  • func WithServerLogger(logger log.Logger) ServerOption
  • func WithServerShutdownTimeout(timeout time.Duration) ServerOption
  • func WithServerTLS(cfg *tls.Config) ServerOption
• type Service

Functions

func Response

func Response(ctx context.Context, w http.ResponseWriter, err error)

Response writes an http error responses to the http.ResponseWriter.

Types

type ResponseError

type ResponseError struct {
	// Status is the http status code applicable to this problem.
	Status int `json:"status,omitempty"`
	// Detail is a human-readable explanation specific to this occurrence of
	// the problem.
	Detail string `json:"detail,omitempty"`
}

ResponseError provides additional information about problems encounted while performing an operation. See: https://jsonapi.org/format/#error-objects

func (ResponseError) Error

func (e ResponseError) Error() string

Error translates the error to a string.

type Server

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

Server represents an HTTP server.

func NewServer

func NewServer(opts ...ServerOption) *Server

NewServer creates an HTTP server with and has not started to accept requests yet.

func (*Server) Register

func (s *Server) Register(services ...Service)

Register associates the given services with the router.

func (*Server) Serve

func (s *Server) Serve() error

Serve accepts incoming connections, creating a new service goroutine for each. The service goroutine reads requests and then call the handler to reply to them.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown stops the http server gracefully without interrupting any active connections.

type ServerOption

type ServerOption interface {
	// contains filtered or unexported methods
}

ServerOption provides options for configuring the creation of a http server.

func WithMiddleware

func WithMiddleware(mw ...mux.MiddlewareFunc) ServerOption

WithMiddleware provide middleware service to be added to the server.

func WithServerAddr

func WithServerAddr(addr string) ServerOption

WithServerAddr will configure the server with the listen address.

func WithServerLogger

func WithServerLogger(logger log.Logger) ServerOption

WithServerLogger provides a logger to the server.

func WithServerShutdownTimeout

func WithServerShutdownTimeout(timeout time.Duration) ServerOption

WithServerShutdownTimeout sets the timout for shutting down the server.

func WithServerTLS

func WithServerTLS(cfg *tls.Config) ServerOption

WithServerTLS will configure the server to require TLS.

type Service

type Service interface {
	// Register will register this service with the given router.
	Register(router *mux.Router)

	// Name provides the name of the service.
	Name() string

	// Shutdown allows the service to stop any long running background processes it
	// may have.
	Shutdown()
}

Service defines the methods required by the Server to register with the service with the router.