server

Documentation

Index

• func EncodeHealthzResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
• func EncodeLivezResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
• func HealthzHealthPath() string
• func LivezHealthPath() string
• func Mount(mux goahttp.Muxer, h *Server)
• func MountHealthzHandler(mux goahttp.Muxer, h http.Handler)
• func MountLivezHandler(mux goahttp.Muxer, h http.Handler)
• func NewHealthzHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NewLivezHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• type MountPoint
• type Server
  • func New(e *health.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) MethodNames() []string
  • func (s *Server) Mount(mux goahttp.Muxer)
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func EncodeHealthzResponse

func EncodeHealthzResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeHealthzResponse returns an encoder for responses returned by the health healthz endpoint.

func EncodeLivezResponse

func EncodeLivezResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeLivezResponse returns an encoder for responses returned by the health livez endpoint.

func HealthzHealthPath

func HealthzHealthPath() string

HealthzHealthPath returns the URL path to the health service healthz HTTP endpoint.

func LivezHealthPath

func LivezHealthPath() string

LivezHealthPath returns the URL path to the health service livez HTTP endpoint.

func Mount

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the health endpoints.

func MountHealthzHandler

func MountHealthzHandler(mux goahttp.Muxer, h http.Handler)

MountHealthzHandler configures the mux to serve the "health" service "healthz" endpoint.

func MountLivezHandler

func MountLivezHandler(mux goahttp.Muxer, h http.Handler)

MountLivezHandler configures the mux to serve the "health" service "livez" endpoint.

func NewHealthzHandler

func NewHealthzHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewHealthzHandler creates a HTTP handler which loads the HTTP request and calls the "health" service "healthz" endpoint.

func NewLivezHandler

func NewLivezHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewLivezHandler creates a HTTP handler which loads the HTTP request and calls the "health" service "livez" endpoint.

Types

type MountPoint

type MountPoint struct {
	// Method is the name of the service method served by the mounted HTTP handler.
	Method string
	// Verb is the HTTP method used to match requests to the mounted handler.
	Verb string
	// Pattern is the HTTP request path pattern used to match requests to the
	// mounted handler.
	Pattern string
}

MountPoint holds information about the mounted endpoints.

type Server

type Server struct {
	Mounts  []*MountPoint
	Healthz http.Handler
	Livez   http.Handler
}

Server lists the health service endpoint HTTP handlers.

func New

func New(
	e *health.Endpoints,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) *Server

New instantiates HTTP handlers for all the health service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.

func (*Server) MethodNames

func (s *Server) MethodNames() []string

MethodNames returns the methods served.

func (*Server) Mount

func (s *Server) Mount(mux goahttp.Muxer)

Mount configures the mux to serve the health endpoints.

func (*Server) Service

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.